Skip to content

docs: correct stale gate_reflect_on_crate_feature doc comments #261

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
iainmcgin wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: correct stale gate_reflect_on_crate_feature doc comments #261

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions buffa-build/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,9 +256,10 @@ impl Config {
/// `buffa-descriptor`-dependent (and `std`-requiring) reflection surface to
/// be opt-in. `buffa-types` is the motivating case.
///
/// **Experimental and `#[doc(hidden)]`**, paired with
/// [`generate_reflection_vtable`](Self::generate_reflection_vtable) until the
/// public `ReflectMode` selector lands.
/// **Experimental and `#[doc(hidden)]`.** This knob only controls the
/// crate-feature gate on the emitted reflection impls; the reflection
/// codegen mode itself is selected via the public
/// [`reflect_mode`](Self::reflect_mode) selector.
#[doc(hidden)]
#[must_use]
pub fn gate_reflect_on_crate_feature(mut self, enabled: bool) -> Self {
Expand Down
2 changes: 1 addition & 1 deletion buffa-codegen/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1169,7 +1169,7 @@ pub struct CodeGenConfig {
/// A low-level knob for crates whose generated code is a public interface
/// (`buffa-types`, the conformance harness). Set directly by `gen_wkt_types`
/// and exposed through `buffa_build::Config::gate_reflect_on_crate_feature`
/// (currently `#[doc(hidden)]`, paired with the experimental vtable flag).
/// (currently `#[doc(hidden)]`).
///
/// Defaults to `false`.
pub gate_reflect_on_crate_feature: bool,
Expand Down
Loading