bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Add explanation of None vs Some("")

Browse source
This commit is contained in:
Rune Tynan 2021-01-20 17:52:52 -05:00
parent 76511a7a71
commit 811fa59db0
No known key found for this signature in database
GPG key ID: 7ECC932F8B2C731E
1 changed files with 2 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

3
src/librustdoc/json/types.rs
View file

@ -68,7 +68,8 @@ pub struct Item {
/// By default all documented items are public, but you can tell rustdoc to output private items
/// so this field is needed to differentiate.
pub visibility: Visibility,
/// The full markdown docstring of this item.
/// The full markdown docstring of this item. Absent if there is no documentation at all,
/// Some("") if there is some documentation but it is empty (EG `#[doc = ""]`).
pub docs: Option<String>,
/// This mapping resolves [intra-doc links](https://github.com/rust-lang/rfcs/blob/master/text/1946-intra-rustdoc-links.md) from the docstring to their IDs
pub links: FxHashMap<String, Id>,