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

Make deprecation reasons more prominent #18042

Closed
kmcallister opened this issue Oct 14, 2014 · 8 comments
Closed

Make deprecation reasons more prominent #18042

kmcallister opened this issue Oct 14, 2014 · 8 comments
Labels
E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@kmcallister
Copy link
Contributor

Right now you have to hold your mouse over a tiny bar next to the function name to find out why it's been deprecated.

@kmcallister kmcallister added E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Oct 14, 2014
@sinistersnare
Copy link
Contributor

+1 maybe just hovering over a deprecated method and its description?

@Gankra
Copy link
Contributor

Gankra commented Oct 14, 2014

An adhoc solution to this we've been using in some places is to replace the documentation of the method with the deprecated message.

@sinistersnare
Copy link
Contributor

Some methods do this already. example: http://doc.rust-lang.org/std/vec/struct.Vec.html#method.append

Lets do that.

@kmcallister
Copy link
Contributor Author

Let's keep the actual docs behind a "click to expand" button, and have rustdoc render the deprecation message as the initially visible part of the docs.

@sfackler
Copy link
Member

Dup of #15468?

@caipre
Copy link
Contributor

caipre commented Dec 14, 2014

I'll take this.

@kmcallister
Copy link
Contributor Author

Nominating for 1.0-stable.

@pnkfelix
Copy link
Member

pnkfelix commented Jan 8, 2015

closing as dupe of #15468

@pnkfelix pnkfelix closed this as completed Jan 8, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. 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

6 participants