Skip to content

Repetition in "Setting your commit email address" article #31789

Description

@julerex

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address

What part(s) of the article would you like to see updated?

Consider this data reusables.user-settings.no-verification-disposable-emails note.

The statement "If you'd like to keep your email address private, you can use a GitHub-provided noreply email address" is repeated directly after the Note.

image

Furthermore, within the Note, the "Setting your commit email address" link has the same title as the article itself, which is confusingly self-referential. Also, the link actually points to a heading that appears just after the Note, rather than the top of the article as one would expect from the link title.

Perhaps this reusable note should be replaced with a sentence that conveys the same information without repetition. Reduction in repetition increases clarity, especially for a novice reader.

Additional information

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    account-and-profileContent relating to account and profilecontentThis issue or pull request belongs to the Docs Content teamhelp wantedAnyone is welcome to open a pull request to fix this issue

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions