diff options
| author | Guillaume Gomez <guillaume.gomez@huawei.com> | 2023-04-15 15:52:27 +0200 |
|---|---|---|
| committer | Guillaume Gomez <guillaume.gomez@huawei.com> | 2023-04-17 11:09:24 +0200 |
| commit | 1531c95c5d3f4e9ef4cfc122c35947e7b9cca53e (patch) | |
| tree | fc5e84951e4f3217430de943d69bd59158b38cdd | |
| parent | a091fd25cae34ebdc3f158e623743d51428952ff (diff) | |
| download | rust-1531c95c5d3f4e9ef4cfc122c35947e7b9cca53e.tar.gz rust-1531c95c5d3f4e9ef4cfc122c35947e7b9cca53e.zip | |
Add code comment to remind contributors to update rustdoc book if they update the disambiguators list
| -rw-r--r-- | src/librustdoc/passes/collect_intra_doc_links.rs | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/src/librustdoc/passes/collect_intra_doc_links.rs b/src/librustdoc/passes/collect_intra_doc_links.rs index 2cd9c8a8781..3b7226df65a 100644 --- a/src/librustdoc/passes/collect_intra_doc_links.rs +++ b/src/librustdoc/passes/collect_intra_doc_links.rs @@ -1419,6 +1419,7 @@ impl Disambiguator { if let Some(idx) = link.find('@') { let (prefix, rest) = link.split_at(idx); let d = match prefix { + // If you update this list, please also update the relevant rustdoc book section! "struct" => Kind(DefKind::Struct), "enum" => Kind(DefKind::Enum), "trait" => Kind(DefKind::Trait), @@ -1437,6 +1438,7 @@ impl Disambiguator { Ok(Some((d, &rest[1..], &rest[1..]))) } else { let suffixes = [ + // If you update this list, please also update the relevant rustdoc book section! ("!()", DefKind::Macro(MacroKind::Bang)), ("!{}", DefKind::Macro(MacroKind::Bang)), ("![]", DefKind::Macro(MacroKind::Bang)), |