Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

src.WorkspaceReadme

Rust
  • Python Unavailable
  • TypeScript Unavailable
  • Rust
  • Go Unavailable
  • Java Unavailable
  • .NET Unavailable
  • C++ Unavailable
  • Swift Unavailable

View as Markdown

Module
src
Package
libtmux
Source
crates/libtmux/src/lib.rs
struct src.WorkspaceReadme
struct [source]
struct [source]
struct src.WorkspaceReadme

Compiles the workspace README's examples, and nothing else.

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.

0 declared, 0 inherited

Esc

Type to search.