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

Some suggestion about the current rustdoc #48935

Closed
chmnchiang opened this issue Mar 11, 2018 · 4 comments
Closed

Some suggestion about the current rustdoc #48935

chmnchiang opened this issue Mar 11, 2018 · 4 comments
Labels
C-enhancement Category: An issue proposing an enhancement or a PR with one. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@chmnchiang
Copy link

  1. Currently, all the folds default to "unfold", so if I want to get a overall view I would have to manually fold all the folds, which I think the opposite is more reasonable: The folds is enabled by default, and let the user click for more details.

  2. There are to many [src] floating on the right. Maybe show them only on hovered will be better.

@ghost
Copy link

ghost commented Mar 11, 2018

so if I want to get a overall view I would have to manually fold all the folds

Unless I'm misunderstanding something, you can click the "master folder" to collapse all folds:
before:
screenshot_2018-03-11_23-02-23

after:
screenshot_2018-03-11_23-02-31

@GuillaumeGomez
Copy link
Member

What's the problem with [src]?

@chmnchiang
Copy link
Author

@xftroxgpx That's what I'm looking for, totally missed that. Thanks.

I think the current doc has the problem that it shows to much repeated but uninformative items at a first glance, which cause users hard to get an overview of the page. Take the second picture @xftroxgpx post as an example, at the first sight, those pub fn and src really stand out, which is probably not users are going to looking for. Something like what ruby doc do, which shows link to source only when hover might be better.

Also I think another problem is that too many words are in bold font. For example, those pub fns are much more conspicuous than the function names, which I believe the later are more important to the reader.

@pietroalbini pietroalbini added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. C-enhancement Category: An issue proposing an enhancement or a PR with one. labels Mar 13, 2018
@jackh726
Copy link
Contributor

Rustdoc has undergone quite a few updates over the years, and I'm not sure these are even relevant anymore. Closing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-enhancement Category: An issue proposing an enhancement or a PR with one. 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