docs: correct stale gate_reflect_on_crate_feature doc comments#261
Open
iainmcgin wants to merge 1 commit into
Open
docs: correct stale gate_reflect_on_crate_feature doc comments#261iainmcgin wants to merge 1 commit into
iainmcgin wants to merge 1 commit into
Conversation
The doc on buffa_build::Config::gate_reflect_on_crate_feature still said it was paired with generate_reflection_vtable "until the public ReflectMode selector lands" - that selector landed (reflect_mode() is public on the same type) and the linked method no longer exists, so the intra-doc link was broken. The codegen-side field doc repeated the same stale pairing claim.
|
All contributors have signed the CLA ✍️ ✅ |
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.
Doc-only fix for a one-PR-at-a-time artifact: the doc comment on
buffa_build::Config::gate_reflect_on_crate_featurestill said the method was paired withgenerate_reflection_vtable"until the publicReflectModeselector lands". That selector landed —reflect_mode()is public on the same type andReflectModeis re-exported at the crate root — and the linked method no longer exists, so the intra-doc link was broken (rustdoc::broken_intra_doc_linksfires on it).Changes:
buffa-build/src/lib.rs: replace the stale pairing sentence with a description of what the knob does today — it controls only the crate-feature gate on emitted reflection impls, while the codegen mode is selected via the publicreflect_mode()selector. The method stays experimental and#[doc(hidden)].buffa-codegen/src/lib.rs: drop the same stale "paired with the experimental vtable flag" claim from thegate_reflect_on_crate_featurefield doc.Verified with
RUSTDOCFLAGS="-D rustdoc::broken_intra_doc_links" cargo doc --no-deps -p buffa-build -p buffa-codegen— clean.