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 doc(spotlight) to doc(notable_trait) #80936

Closed
camelid opened this issue Jan 12, 2021 · 3 comments · Fixed by #80965
Closed

Rename doc(spotlight) to doc(notable_trait) #80936

camelid opened this issue Jan 12, 2021 · 3 comments · Fixed by #80965
Assignees
@camelid
Labels
A-traits Area: Trait system 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

@camelid
Copy link
Member

camelid commented Jan 12, 2021 •
edited by rustbot
Loading

Leaving this as a todo for myself:

We should probably rename this flag to notable_trait since (a) it's clearer and (b) that's what the popup that it triggers is called. We should probably do it in another PR though; I'll try to do that soon.

Originally posted by @camelid in #80914 (comment)

@rustbot claim
@camelid camelid added A-traits Area: Trait system 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. labels Jan 12, 2021
@jyn514
Copy link
Member

jyn514 commented Jan 12, 2021

This is a user-facing change. I know doc(spotlight) is nightly only, but is the improvement worth it? I think spotlight is reasonably clear.

cc @Manishearth

@camelid
Copy link
Member Author

camelid commented Jan 12, 2021

I don't think it's that clear of a name. "spotlight" could mean many things, but doc(spotlight) means a very specific thing. For example, I could imagine "spotlight" meaning that rustdoc puts it at the top of the module page and highlights it.

@camelid camelid mentioned this issue Jan 12, 2021
Merged
@Manishearth
Copy link
Member

Yeah, I feel like we should call it notable_trait or something since most users won't know the name "spotlight".

@camelid camelid mentioned this issue Jan 13, 2021
Merged
Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this issue Apr 1, 2021
@Dylan-DPC
Rollup merge of rust-lang#80965 - camelid:rename-doc-spotlight, r=jyn514
1e5ae60 
Rename `#[doc(spotlight)]` to `#[doc(notable_trait)]`

Fixes rust-lang#80936.

"spotlight" is not a very specific or self-explaining name.
Additionally, the dialog that it triggers is called "Notable traits".
So, "notable trait" is a better name.

* Rename `#[doc(spotlight)]` to `#[doc(notable_trait)]`
* Rename `#![feature(doc_spotlight)]` to `#![feature(doc_notable_trait)]`
* Update documentation
* Improve documentation

r? `@Manishearth`
@bors bors closed this as completed in 5662d93 Apr 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@camelid camelid

Labels
A-traits Area: Trait system 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
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Rename #[doc(spotlight)] to #[doc(notable_trait)] camelid/rust
3 participants
@Manishearth @jyn514 @camelid