-
Notifications
You must be signed in to change notification settings - Fork 12.7k
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
[rustdoc] unclear experimental api notes #51387
Comments
How about ...
or
|
The indent change seems like a better idea from my point of view so I'll go for this one. |
It doesn't seem like the indentation fix is actually doing anything for the issue you're describing. You seem to have more of an issue about the unstable banner appearing outside the "folded" docs, creating a situation where it's not obvious which function declaration it's attached to, at least when everything's folded up. Would folding the unstable banner inside the docs help? |
You are totaly right, I didn't even noticed it! That would be good as well, but then you have to explictly unfold the item (if you folded all items, for example with the keyboard) to see, that it is unstable. |
I really like the expiremental flag. |
We can't put it on the same line, it's already super loaded. |
|
This isn't the issue. In case you have a super long function/trait/whatever name, it'll be very ugly and difficult to read. This line is at its max length so we'll have to find another location. |
…-display, r=QuietMisdreavus Improve unstable message display Fixes rust-lang#51387. Reopening of rust-lang#51563. New display: <img width="1440" alt="screen shot 2018-08-04 at 00 01 39" src="https://user-images.githubusercontent.com/3050060/43667793-dc14f708-9779-11e8-9808-f3ff126fc213.png"> r? @QuietMisdreavus
Remove "up here" arrow on item-infos Use spacing to distinguish what is related to a given heading. This was originally introduced in rust-lang#53043, in response to rust-lang#51387. The arrow is a little distracting, and leads the item-info to not be aligned properly with the text below it. Demo: https://rustdoc.crud.net/jsha/impl-spacing/std/string/struct.String.html r? `@GuillaumeGomez`
Remove "up here" arrow on item-infos Use spacing to distinguish what is related to a given heading. This was originally introduced in rust-lang#53043, in response to rust-lang#51387. The arrow is a little distracting, and leads the item-info to not be aligned properly with the text below it. Demo: https://rustdoc.crud.net/jsha/impl-spacing/std/string/struct.String.html r? ``@GuillaumeGomez``
Which API is a nightly-only experimental API? The one followed by the note, or the one it follows? It's not very clear to me.
The text was updated successfully, but these errors were encountered: