fix: correct the rfc-index example (See Also is STD/BCP/FYI, not RFC) - #11320
Merged
jennifer-richards merged 1 commit intoAug 7, 2026
Merged
Conversation
The example atop the generated rfc-index.txt showed RFC 1129 with a `(Also RFC1119)` See Also, but the file's own Key to citations says `(Also ...)` only gives an equivalent FYI/STD/BCP number, never another RFC -- and the real RFC 1129 entry has no See Also. Replace it with the RFC 9915 example (a genuine `(Also STD102)`) suggested in the issue. Closes ietf-tools#11280.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #11320 +/- ##
=======================================
Coverage 88.58% 88.58%
=======================================
Files 333 333
Lines 44662 44670 +8
=======================================
+ Hits 39565 39573 +8
Misses 5097 5097 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
ajeanmahoney
approved these changes
Jul 30, 2026
jennifer-richards
approved these changes
Aug 7, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The example at the top of the generated
rfc-index.txt(fromietf/templates/sync/rfc-index.txt) shows RFC 1129 with a(Also RFC1119)See Also:But the file's own "Key to citations" states that
(Also FYI ##)/(Also STD ##)/(Also BCP ##)only give an equivalent FYI/STD/BCP number — a See Also never points at another RFC — and the actual RFC 1129 entry has no See Also. So(Also RFC1119)is not a valid example.This replaces it with the RFC 9915 example suggested in #11280, which carries a genuine
(Also STD102):Continuation lines are indented to align under the title, matching the surrounding template style. One file, docs/template only.
Closes #11280.
Disclosure: prepared with AI assistance; I reviewed the change against the file's Key to citations and the suggested fix in the issue.