Update documentation for SharedContext::maybe_collapsed_doc_value

This commit is contained in:
Guillaume Gomez 2021-05-10 10:49:44 +02:00
parent 00f2bf40d6
commit 08519959c7

View File

@ -135,8 +135,8 @@ impl SharedContext<'_> {
Ok(())
}
/// Based on whether the `collapse-docs` pass was run, return either the `doc_value` or the
/// `collapsed_doc_value` of the given item.
/// Returns the `collapsed_doc_value` of the given item if this is the main crate, otherwise
/// returns the `doc_value`.
crate fn maybe_collapsed_doc_value<'a>(&self, item: &'a clean::Item) -> Option<String> {
if self.collapsed { item.collapsed_doc_value() } else { item.doc_value() }
}