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.

Sign up for GitHub

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

Jump to bottom

Rename "important traits" to something better #75245

Closed
Manishearth opened this issue Aug 7, 2020 · 3 comments · Fixed by #75344
Closed

Rename "important traits" to something better #75245

Manishearth opened this issue Aug 7, 2020 · 3 comments · Fixed by #75344
Assignees
@camelid
Labels
C-cleanup Category: PRs that clean code up or issues documenting cleanup. 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

@Manishearth
Copy link
Member

Manishearth commented Aug 7, 2020 •
edited by rustbot
Loading

A lot of the feedback on https://internals.rust-lang.org/t/feedback-on-important-traits-rustdoc-feature/12752 had better suggestions for the "important traits" feature.

Some options were:

  • Featured traits
  • Key traits
  • Notable traits

My personal preference is for "notable traits" because "important" is a much stronger value judgement whereas "notable" basically means "we thought you should know this" which is exactly what the feature does.

Thoughts? @rust-lang/rustdoc

We should pick something and rename.
@Manishearth Manishearth added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Aug 7, 2020
@GuillaumeGomez
Copy link
Member

I don't have strong feelings here but I think "Notable traits" is the best proposition out of the three.

@jyn514
Copy link
Member

jyn514 commented Aug 7, 2020

I agree 👍 , "featured traits" might be confused with cargo features and "key traits" has different connotations in my mind.

@jyn514 jyn514 added the C-cleanup Category: PRs that clean code up or issues documenting cleanup. label Aug 7, 2020
@Manishearth Manishearth added the E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. label Aug 7, 2020
@camelid
Copy link
Member

camelid commented Aug 9, 2020

I'd be interested in doing this.

@rustbot claim

@camelid camelid mentioned this issue Aug 9, 2020
Merged
@bors bors closed this as completed in 8176240 Aug 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@camelid camelid

Labels
C-cleanup Category: PRs that clean code up or issues documenting cleanup. 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
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Rename "Important traits" to "Notable traits" camelid/rust
4 participants
@Manishearth @GuillaumeGomez @jyn514 @camelid