Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 

README.md

Docs.rs Ferris

Show Ferris the crab on docs.rs code examples, just like on the Rust book.

compile_fail

should_panic

List of Ferris

From The Rust Book

Ferris Shortcode Meaning
does_not_compile does_not_compile This code does not compile!
panics panics This code panics!
not_desired_behavior not_desired_behavior This code does not produce the desired behavior.

Details

Here's a list of rustdoc attributes and their corresponding Ferris:

Attribute Ferris When
should_panic panics Always
compile_fail does_not_compile Always
ignore not_desired_behavior If Show Ferris on ignore is enabled
no_run not_desired_behavior If Show Ferris on no_run is enabled

Configurations

Show attributes

Show the attribute above the code block. Only supports attributes mentioned in the Details section.

show_attributes

Show Ferris on ignore

Show not_desired_behavior Ferris on ignore attributes.

Show Ferris on no_run

Show not_desired_behavior Ferris on no_run attributes.

Opacity

Configure the opacity of Ferris.

Size

Configure the size of Ferris.

Right offset

Configure the right offset of Ferris.

Top offset

Configure the top offset of Ferris.