Skip to content

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

Closed

Description

@camelid

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

Activity

  1. added
    C-enhancementCategory: An issue proposing an enhancement or a PR with one.
    T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.
    on Jan 12, 2021
  2. jyn514 commented on Jan 12, 2021

    @jyn514
    Member

    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

  3. camelid commented on Jan 12, 2021

    @camelid
    MemberAuthor

    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.

  4. Manishearth commented on Jan 13, 2021

    @Manishearth
    Member

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

  5. added a commit that references this issue on Apr 1, 2021
    1e5ae60
  6. added a commit that references this issue on Apr 2, 2021
    5662d93
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

A-trait-systemArea: Trait systemC-enhancementCategory: An issue proposing an enhancement or a PR with one.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions