-
Notifications
You must be signed in to change notification settings - Fork 1.6k
rustdoc
or cargo doc
should pass a special --cfg doc
flag
#834
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
Conversation
|
||
# Alternatives | ||
|
||
* The identifier `rustdoc` can be changed to something else. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this should just be doc
. rustdoc
sounds specific to the rustdoc
tool itself, and so if someone made another documentation tool for Rust called something else, the rustdoc
cfg attr wouldn’t really make much sense any more. A generic doc
cfg sounds much more general.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, doc
sounds better to me.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1 on doc
.
rustdoc
or cargo doc
should pass a special --cfg rustdoc
flag rustdoc
or cargo doc
should pass a special --cfg doc
flag
This is probably a good idea for us to do. However, now is not the time - we are very close to the 1.0 release and this is neither urgent nor has backwards compatibility hazards. Therefore we decided it should be closed as postponed. I created #915 to track this issue for now. |
Should we re-open this RFC? The proposal seems pretty straightforward, and we're already in the 1.6 cycle. |
Ping? |
I think this is a good idea, but this also means that there must not be any compile errors from any of the |
Rendered
cc rust-lang/rust#19240