docs: fix broken intra-doc links under -D warnings#87
Open
Conversation
SENTINEL_MOD and package_to_mod_filename linked to the crate-private validate_file; extension.rs linked to the type_registry module which is gated behind cfg(any(json, text)). Both fail RUSTDOCFLAGS=-D warnings cargo doc on default features. Replaced with plain code spans.
|
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.
Unblocks
RUSTDOCFLAGS=-D warnings cargo doc --workspace --no-depson default features (part of the pre-tag verify).buffa-codegen:SENTINEL_MODandpackage_to_mod_filenamelinked to the crate-privatevalidate_file(public_private_link).buffa/src/extension.rs: module doc linked tocrate::type_registry, which is#[cfg(any(feature = "json", feature = "text"))]and therefore unresolved on default features (broken_intra_doc_links).Both replaced with plain code spans. No behavior change.
Separately discovered while testing this:
cargo build -p buffa-types --features arbitraryfails to compile (Any.value: ByteslacksArbitrary<'_>). Regression from #51; tracked separately.