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: make static functions stand out better #15070

Closed
o11c opened this issue Jun 21, 2014 · 8 comments
Closed

rustdoc: make static functions stand out better #15070

o11c opened this issue Jun 21, 2014 · 8 comments
Labels
C-feature-request Category: A feature request, i.e: not implemented / a PR. T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@o11c
Copy link

o11c commented Jun 21, 2014

Both me and some random guy on IRC today were reading the docs, and completely missed the fact that certain functions were static. They should visually stand out, even while just skimming.

@thestinger
Copy link
Contributor

Can you elaborate on what you mean by this?

@o11c
Copy link
Author

o11c commented Jun 21, 2014

In most languages, self is not explicit, so people are not used to using it as the distinguisher of static vs nonstatic methods, and they are used to seeing the visually-distinct word static preceding static methods.

Even though Rust does things differently, there is no reason for it to give up visual distinctness.

@steveklabnik steveklabnik added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Jan 23, 2015
@steveklabnik
Copy link
Member

Triage: no change.

@steveklabnik steveklabnik added T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. and removed T-tools labels May 18, 2017
@Mark-Simulacrum Mark-Simulacrum added the C-feature-request Category: A feature request, i.e: not implemented / a PR. label Jul 21, 2017
@steveklabnik
Copy link
Member

Triage: still no changes. @rust-lang/rustdoc do we ever plan on implementing this?

@GuillaumeGomez
Copy link
Member

If we do this, we'll have to think a lot about how we'll do it (on the UI side).

@QuietMisdreavus
Copy link
Member

it could be as simple as sorting non-self functions above the rest, but that would probably surface another issue for items with multiple impl blocks. Since rustdoc currently groups methods together by their impl block (since they could have different conditions attached to them, different trait bounds or type parameters, or just being written in different files), it just grabs the impl as a whole. However, i think reordering the items within the impl will still get the majority of cases.

@GuillaumeGomez
Copy link
Member

We should maybe just re-order items alphabetically in the first place.

@Mark-Simulacrum
Copy link
Member

I'm going to close this as we don't have consensus (and, I, for one don't even think we should do anything here).

bors added a commit to rust-lang-ci/rust that referenced this issue Jul 17, 2023
internal: Report metric timings for file item trees and crate def map creation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-feature-request Category: A feature request, i.e: not implemented / a PR. T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/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