Skip to content

Default cargo features should include doc-default features #1943

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

Open
clarfonthey opened this issue Mar 5, 2017 · 2 comments
Open

Default cargo features should include doc-default features #1943

clarfonthey opened this issue Mar 5, 2017 · 2 comments
Labels
T-doc Relevant to the documentation team, which will review and decide on the RFC.

Comments

@clarfonthey
Copy link

Crate maintainers should be allowed to specify features which are off by default, but enabled by default in docs. This would allow people to compile docs for all of the extra features, while also turning these features off by default for most builds.

@codyps
Copy link

codyps commented Mar 6, 2017

rust-lang/rust#9461 has some discussion related to this (in the context of docs.rs), and also links to onur/docs.rs#73 which contains a similar thing, but specifically for docs.rs.

Given that other folks are generating documentation than docs.rs, it does seem like a general configuration variable would be appropriate.

@clarfonthey
Copy link
Author

clarfonthey commented Mar 8, 2017

Personally, I think that a docs-default = [...] option would suffice; it'd be not too difficult to implement, and could be implemented in cargo itself. I think that just isolating this to docs.rs isn't the best because I personally would like to run cargo doc and get the same default behaviour that docs.rs has.

@Centril Centril added the T-doc Relevant to the documentation team, which will review and decide on the RFC. label Dec 6, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T-doc Relevant to the documentation team, which will review and decide on the RFC.
Projects
None yet
Development

No branches or pull requests

3 participants