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

Show unstable status for deprecated items #32374

Closed
bluss opened this issue Mar 20, 2016 · 2 comments
Closed

Show unstable status for deprecated items #32374

bluss opened this issue Mar 20, 2016 · 2 comments
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@bluss
Copy link
Member

bluss commented Mar 20, 2016

A deprecated item should still show its unstable status in the docs, otherwise both stable + deprecated and unstable + deprecated items are presented the same way (only the source code tells you the difference).

This is a problem because without the unstable label, doc items will be assumed to be stable by users.

Issue #24617 seems to be similar, but not exactly the same.

@bluss bluss added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Mar 20, 2016
@euclio
Copy link
Contributor

euclio commented Apr 14, 2016

I'd like to work on this. Is there some documentation somewhere on how to build/hack on rustdoc?

@mitaa
Copy link
Contributor

mitaa commented Apr 14, 2016

I don't think so..

// build just the rustdoc binary, useful for local experiments
make x86_64-unknown-linux-gnu/stage1/bin/rustdoc
// run the src/test/rustdoc tests
make check-stage1-rustdocck

For writing rustdoc tests you need to look at src/etc/htmldocck.py, which is run on the generated documentation, and compiletest and its flags in general.
(using existing tests as guidance is always useful - i.e. rustdoc tests with auxiliary crates need to be marked // ignore-cross-compile)

Manishearth added a commit to Manishearth/rust that referenced this issue Apr 25, 2016
… r=alexcrichton

show unstable status for deprecated items

Fixes rust-lang#32374.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

3 participants