WorkspaceReadme
Compiles the workspace README's examples, and nothing else.
Source and package
- Qualified name
-
libtmux::Workspace Readme - Module
- src
- Package
- libtmux
- Source
- crates/libtmux/src/lib.rs
-
Description#
The crate README is the crate documentation, so rustdoc already runs its examples. The one at the repository root is the page most readers see first and had no such check, which is how an example that never compiled sat there.
cfg(doctest)means this exists only while doctests run, so it costs a normal build nothing and appears in no documentation.