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.

Sign up for GitHub

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

Jump to bottom

Deprecation should be more visible in rustdoc output #15468

Closed
sfackler opened this issue Jul 6, 2014 · 8 comments
Closed

Deprecation should be more visible in rustdoc output #15468

sfackler opened this issue Jul 6, 2014 · 8 comments
Assignees
@alexcrichton
Labels
P-medium Medium priority T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@sfackler
Copy link
Member

sfackler commented Jul 6, 2014

It's currently handled like any other stability attribute, but I think we want something more explicit for the case of deprecation. For example, javadoc prints the deprecation warning both in the table of contents and the documentation for a deprecated method: http://docs.oracle.com/javase/7/docs/api/java/lang/Thread.html#resume(). We'll want to make sure that it's easily visible even on the search results page so people can avoid clicking into and using deprecated API by accident.
@tomjakubowski
Copy link
Contributor

I like what the Google Closure Library API docs do with deprecated functions, marking them clearly with a shaded background.

@emberian
Copy link
Member

2014-07-28-171825_1487x470_scrot

Is what it looks like now. Do you consider this fixed, @sfackler ?

@sfackler
Copy link
Member Author

The deprecation message is still hidden unless you mouse over the "deprecated" text.

@aturon
Copy link
Member

aturon commented Jul 29, 2014

cc me

@sfackler
Copy link
Member Author

Search results still have no indication that something's deprecated as well.

@steveklabnik
Copy link
Member

I found this annoying today too. We should certainly show the message on the page.

This was referenced Oct 10, 2014
Open
Closed
@pnkfelix
Copy link
Member

pnkfelix commented Jan 8, 2015

not necessary for 1.0. (also, some note that deprecated is for usage within the standard library, not for end-user crates).

P-high.

@pnkfelix pnkfelix added the P-medium Medium priority label Jan 8, 2015
@caipre
Copy link
Contributor

caipre commented Jan 11, 2015

I'm still working on this, albeit slowly. It's not as easy (for a rust novice) as I initially suspected it might be.

@steveklabnik steveklabnik mentioned this issue Jan 12, 2015
Closed
@alexcrichton alexcrichton self-assigned this Apr 10, 2015
alexcrichton added a commit to alexcrichton/rust that referenced this issue Apr 14, 2015
@alexcrichton
rustdoc: Overhaul stability displays
ff3b7c5 
This commit is an overhaul to how rustdoc deals with stability of the standard
library. The handling has all been revisited with respect to Rust's current
approach to stability in terms of implementation as well as the state of the
standard library today. The high level changes made were:

* Stable items now have no marker by default
* Color-based small stability markers have been removed
* Module listings now fade out unstable/deprecated items slightly
* Trait methods have a separate background color based on stability and also
  list the reason that they are unstable.
* `impl` blocks with stability no longer render at all. This may be re-added
  once the compiler recognizes stability on `impl` blocks.
* `impl` blocks no longer have stability of the methods implemente indicated
* The stability summary has been removed

Closes rust-lang#15468
Closes rust-lang#21674
Closes rust-lang#24201
alexcrichton added a commit to alexcrichton/rust that referenced this issue Apr 15, 2015
@alexcrichton
rustdoc: Overhaul stability displays
941593d 
This commit is an overhaul to how rustdoc deals with stability of the standard
library. The handling has all been revisited with respect to Rust's current
approach to stability in terms of implementation as well as the state of the
standard library today. The high level changes made were:

* Stable items now have no marker by default
* Color-based small stability markers have been removed
* Module listings now fade out unstable/deprecated items slightly
* Trait methods have a separate background color based on stability and also
  list the reason that they are unstable.
* `impl` blocks with stability no longer render at all. This may be re-added
  once the compiler recognizes stability on `impl` blocks.
* `impl` blocks no longer have stability of the methods implemente indicated
* The stability summary has been removed

Closes rust-lang#15468
Closes rust-lang#21674
Closes rust-lang#24201
quantheory pushed a commit to quantheory/rust that referenced this issue Apr 17, 2015
@alexcrichton @quantheory
rustdoc: Overhaul stability displays
db2b5b9 
This commit is an overhaul to how rustdoc deals with stability of the standard
library. The handling has all been revisited with respect to Rust's current
approach to stability in terms of implementation as well as the state of the
standard library today. The high level changes made were:

* Stable items now have no marker by default
* Color-based small stability markers have been removed
* Module listings now fade out unstable/deprecated items slightly
* Trait methods have a separate background color based on stability and also
  list the reason that they are unstable.
* `impl` blocks with stability no longer render at all. This may be re-added
  once the compiler recognizes stability on `impl` blocks.
* `impl` blocks no longer have stability of the methods implemente indicated
* The stability summary has been removed

Closes rust-lang#15468
Closes rust-lang#21674
Closes rust-lang#24201
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@alexcrichton alexcrichton

Labels
P-medium Medium priority T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
8 participants
@steveklabnik @alexcrichton @pnkfelix @caipre @tomjakubowski @emberian @aturon @sfackler