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

[rustdoc] unclear experimental api notes #51387

Closed
liigo opened this issue Jun 6, 2018 · 10 comments
Closed

[rustdoc] unclear experimental api notes #51387

liigo opened this issue Jun 6, 2018 · 10 comments
Assignees
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@liigo
Copy link
Contributor

liigo commented Jun 6, 2018

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.

notes

@hellow554
Copy link
Contributor

You are right. Any ideas how to improve it?
One solution could be an indention on the same level as the methodcomment is.

grafik

Any other ideas?

@liigo
Copy link
Contributor Author

liigo commented Jun 7, 2018

How about ...

escape_debug is a nightly-only experimental API

or

🡹⇪↑⇪This is a nightly-only experimental API

@GuillaumeGomez GuillaumeGomez self-assigned this Jun 9, 2018
@GuillaumeGomez GuillaumeGomez added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Jun 9, 2018
@GuillaumeGomez
Copy link
Member

The indent change seems like a better idea from my point of view so I'll go for this one.

@QuietMisdreavus
Copy link
Member

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?

@hellow554
Copy link
Contributor

hellow554 commented Jun 15, 2018

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.
So I am a little bit indecisive. One may want to hide the unstable box, but you also should always be able to see, that that one is unstable? :| Hmmm... @GuillaumeGomez help! 😆

@liigo
Copy link
Contributor Author

liigo commented Jul 3, 2018

How about tag it with experimental/unstable/0.0.0 ? (and a popup tooltip)
exp

@hellow554
Copy link
Contributor

I really like the expiremental flag. 0.0.0 is not that expressive I think. Or instead of experimental nightly-only? Or use a yellow-ish background?

@GuillaumeGomez
Copy link
Member

We can't put it on the same line, it's already super loaded.

@liigo
Copy link
Contributor Author

liigo commented Jul 11, 2018

We can't put it on the same line, it's already super loaded.

0.0.0 (or exp.) is not longer than 1.2.0, I think.

@GuillaumeGomez
Copy link
Member

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.

GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this issue Aug 26, 2018
…-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
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Feb 5, 2022
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`
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Feb 6, 2022
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``
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

4 participants