Fix doc comment space in generated field docs#16
Open
kostakost2 wants to merge 1 commit intoanthropics:mainfrom
Open
Fix doc comment space in generated field docs#16kostakost2 wants to merge 1 commit intoanthropics:mainfrom
kostakost2 wants to merge 1 commit intoanthropics:mainfrom
Conversation
Fixes anthropics#4. prettyplease renders `#[doc = "X"]` as `///X` verbatim (no space insertion). By prepending a space to the three field doc format strings the generated output becomes `/// X` per rustdoc style. Three one-character changes: - buffa-codegen/src/message.rs: field doc line - buffa-codegen/src/view.rs: map field doc line - buffa-codegen/src/view.rs: regular field doc line
|
I have read the CLA Document and I hereby sign the CLA Claude Lab seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. |
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
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.
Fixes #4.
Problem
prettyplease renders
#[doc = "X"]verbatim as///X— no space after the slashes. This produces generated output like:Fix
Prepend a single space to the three field doc format strings in the codegen so the emitted
#[doc = " Field ..."]renders as/// Field ...per rustdoc convention.Three sites changed:
message.rs:1062,view.rs:318,view.rs:329.cargo build --package buffa-codegenpasses. Full test suite requiresprotocwhich is unavailable in my environment, but the changes are mechanical and self-contained.