Function documentation
fn documentation(attrs: &[Attribute]) -> Result<Vec<String>, Error>Expand description
The doc comment on an item, as Markdown paragraphs.
Reference definitions are resolved before the intra-doc rewrite, the way
space_dsl and journal do it and this generator did not. A variant that
wrote [`Space`] in its prose and put [`Space`]: https://docs.rs/atune
on a line of its own — rustdoc’s ordinary spelling, and the only one that keeps
a long URL out of the sentence — had the definition published as a stray
paragraph and the shortcut stripped to a bare code span by
markdown::strip_intra_doc_links: the link silently became text, on a page
nothing else validates (§1.3.152). No variant writes one today, which is why the
gap was invisible; the next one to would have found out on the published page.