docs(ast): discipline comments per comment spec - #22
Open
Boreas618 wants to merge 1 commit into
Open
Conversation
- removed 2 narrations of the obvious (§5.1): impl-block header on FnCall and the end-of-line 'combine prefix with :: separator' comment - rewrote 1 imprecise doc (§4/§8.1): Pos is a byte offset (pest span start), not 'byte offset or character index' - reviewed 6 files; remaining dense rustdoc field/variant docs kept as borderline keeps under house style (no dividers, tags, or commented-out code found in scope)
Boreas618
force-pushed
the
docs/comment-discipline-ast
branch
from
August 1, 2026 10:58
58746d0 to
c65c1c6
Compare
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Comment-discipline sweep of the AST files not covered by other PRs (
decl,expr,ops,program,stmt,types), per the repo comment specification:format!.Posdoc no longer hedges between byte offset and character index — it is a byte offset (verified atparser/common.rs).Comments-only;
cargo buildclean; no new rustdoc warnings.