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

docs: Address an upcoming violation of markdownlint rule MD050/strong-style. #15529

Merged
merged 1 commit into from Jan 18, 2022
Merged

docs: Address an upcoming violation of markdownlint rule MD050/strong-style. #15529

merged 1 commit into from Jan 18, 2022

Conversation

DavidAnson
Copy link
Contributor

@DavidAnson DavidAnson commented Jan 18, 2022

This file (and only this file in the repo) uses both __ and ** to create a strong emphasis. This change makes the file consistent by changing the single instance of __ to **. The current version of markdownlint and an upcoming version of markdownlint-cli do/will flag this violation. The new rule can be disabled, but resolving it in this case is trivial.

More info: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md050

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

See above/commit message.

Is there anything you'd like reviewers to focus on?

Check the word "not" is still strongly emphasized and the use of strong emphasis in the file is uniform.

@eslint-github-bot eslint-github-bot bot added the triage label Jan 18, 2022
@linux-foundation-easycla
Copy link

@linux-foundation-easycla linux-foundation-easycla bot commented Jan 18, 2022

CLA Signed

The committers are authorized under a signed CLA.

@eslint-github-bot
Copy link

@eslint-github-bot eslint-github-bot bot commented Jan 18, 2022

Hi @DavidAnson!, thanks for the Pull Request

The first commit message isn't properly formatted. We ask that you update the message to match this format, as we use it to generate changelogs and automate releases.

  • The commit message tag wasn't recognized. Did you mean "docs", "fix", or "feat"?
  • There should be a space following the initial tag and colon, for example 'feat: Message'.
  • The first letter of the tag should be in lowercase

To Fix: You can fix this problem by running git commit --amend, editing your commit message, and then running git push -f to update this pull request.

Read more about contributing to ESLint here

@eslint-github-bot
Copy link

@eslint-github-bot eslint-github-bot bot commented Jan 18, 2022

Hi @DavidAnson!, thanks for the Pull Request

The first commit message isn't properly formatted. We ask that you update the message to match this format, as we use it to generate changelogs and automate releases.

  • The length of the commit message must be less than or equal to 72

To Fix: You can fix this problem by running git commit --amend, editing your commit message, and then running git push -f to update this pull request.

Read more about contributing to ESLint here

@DavidAnson
Copy link
Contributor Author

@DavidAnson DavidAnson commented Jan 18, 2022

I updated the commit message once to add a prefix due to commit-message failing. It looks like it's still unhappy, perhaps the length is too long? Reviewers, please feel free to remove any part of the commit message you do not feel is useful or let me know how you'd like it changed - I've tried to be clear without leaving out context. Thanks.

Copy link
Member

@aladdin-add aladdin-add left a comment

LGTM, thanks!

@aladdin-add aladdin-add changed the title Address an upcoming violation of markdownlint rule MD050/strong-style. docs: Address an upcoming violation of markdownlint rule MD050/strong-style. Jan 18, 2022
@eslint-github-bot
Copy link

@eslint-github-bot eslint-github-bot bot commented Jan 18, 2022

Hi @DavidAnson!, thanks for the Pull Request

The first commit message isn't properly formatted. We ask that you update the message to match this format, as we use it to generate changelogs and automate releases.

  • The length of the commit message must be less than or equal to 72

To Fix: You can fix this problem by running git commit --amend, editing your commit message, and then running git push -f to update this pull request.

Read more about contributing to ESLint here

@eslint-github-bot eslint-github-bot bot added the documentation label Jan 18, 2022
Copy link
Contributor

@snitin315 snitin315 left a comment

LGTM, thank you.

@snitin315 snitin315 added accepted and removed triage labels Jan 18, 2022
nzakas
nzakas approved these changes Jan 18, 2022
Copy link
Member

@nzakas nzakas left a comment

LGTM. Thanks!

@nzakas nzakas merged commit 7d7af55 into eslint:main Jan 18, 2022
13 of 14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants