diff options
| author | Rune Tynan <runetynan@gmail.com> | 2021-01-20 17:52:52 -0500 |
|---|---|---|
| committer | Rune Tynan <runetynan@gmail.com> | 2021-01-20 17:52:52 -0500 |
| commit | 811fa59db0210c8c5eeb86e47d858c88e3460d07 (patch) | |
| tree | ab56141af4a56050aa2daa247a889a09ce3c2b4d | |
| parent | 76511a7a71660b564040bfadb466251fbfa0167b (diff) | |
| download | rust-811fa59db0210c8c5eeb86e47d858c88e3460d07.tar.gz rust-811fa59db0210c8c5eeb86e47d858c88e3460d07.zip | |
Add explanation of None vs Some("")
| -rw-r--r-- | src/librustdoc/json/types.rs | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/src/librustdoc/json/types.rs b/src/librustdoc/json/types.rs index 2f6db0231ab..c148602009f 100644 --- a/src/librustdoc/json/types.rs +++ b/src/librustdoc/json/types.rs @@ -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>, |