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

Remove manual --cfg docsrs in Cargo.toml metadata #14132

Open
BD103 opened this issue Jul 4, 2024 · 0 comments
Open

Remove manual --cfg docsrs in Cargo.toml metadata #14132

BD103 opened this issue Jul 4, 2024 · 0 comments
Labels
A-Build-System Related to build systems or continuous integration C-Docs An addition or correction to our documentation C-Enhancement A new feature D-Trivial Nice and easy! A great choice to get started with Bevy

Comments

@BD103
Copy link
Member

BD103 commented Jul 4, 2024

What problem does this solve or what need does it fill?

At the bottom of every public crate is the following:

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

This allows code to check that it is building on docs.rs using #[cfg(docsrs)]. It's frequently used for nightly docs annotations, such as enabling auto-feature-documentation. The --cfg docsrs section of rustdoc-args can be removed, since it is now passed to all crates instead of just the main one being built.

What solution would you like?

Remove --cfg docsrs from the Cargo.toml, and re-evaluate if -Zunstable-options is still necessary.

Additional context

@BD103 BD103 added C-Docs An addition or correction to our documentation C-Enhancement A new feature D-Trivial Nice and easy! A great choice to get started with Bevy A-Build-System Related to build systems or continuous integration labels Jul 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Build-System Related to build systems or continuous integration C-Docs An addition or correction to our documentation C-Enhancement A new feature D-Trivial Nice and easy! A great choice to get started with Bevy
Projects
None yet
Development

No branches or pull requests

1 participant