Skip to content

Commit 811fa59

Browse files
committed
Add explanation of None vs Some("")
1 parent 76511a7 commit 811fa59

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

src/librustdoc/json/types.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,8 @@ pub struct Item {
6868
/// By default all documented items are public, but you can tell rustdoc to output private items
6969
/// so this field is needed to differentiate.
7070
pub visibility: Visibility,
71-
/// The full markdown docstring of this item.
71+
/// The full markdown docstring of this item. Absent if there is no documentation at all,
72+
/// Some("") if there is some documentation but it is empty (EG `#[doc = ""]`).
7273
pub docs: Option<String>,
7374
/// 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
7475
pub links: FxHashMap<String, Id>,

0 commit comments

Comments
 (0)