Skip to content
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.

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

Polish rustdocs generated from our published crates #10475

Open
nagisa opened this issue Jan 22, 2024 · 0 comments
Open

Polish rustdocs generated from our published crates #10475

nagisa opened this issue Jan 22, 2024 · 0 comments

Comments

@nagisa
Copy link
Collaborator

nagisa commented Jan 22, 2024

As a minimum all published crates should contain something along the lines of

[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "nearcore_rustdoc"]

in their Cargo.toml (alongside a themis rule to ensure this remains true) as well as doc_auto_cfg feature enabled at the very minimum (through #![cfg_attr(nearcore_rustdoc, feature(doc_{auto_,}cfg))]). Thus ensuring that the documentation is complete and the references are in place for conditionally-enabled items.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant