Skip to content

Conversation

kenji-miyake
Copy link
Contributor

@kenji-miyake kenji-miyake commented Nov 7, 2022

Description

To use consistent styles, I think it's good to use ordered for MD029.
The default value is one_or_ordered, and it allows two different styles.

For more details, please refer to https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md029---ordered-list-item-prefix.

Pre-review checklist for the PR author

The PR author must check the checkboxes below when creating the PR.

In-review checklist for the PR reviewers

The PR reviewers must check the checkboxes below before approval.

Post-review checklist for the PR author

The PR author must check the checkboxes below before merging.

  • There are no open discussions or they are tracked via tickets.

After all checkboxes are checked, anyone who has write access can merge the PR.

Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp>
@kenji-miyake kenji-miyake requested a review from xmfcx November 7, 2022 10:25
@kenji-miyake
Copy link
Contributor Author

With this change, the following style isn't allowed.
image

We need to fix it to the following style. If you write 2., it will be automatically formatted.
image

@xmfcx
Copy link
Contributor

xmfcx commented Nov 7, 2022

I agree with the ordered style as long as it is automatically enforced, fixed.

@kenji-miyake kenji-miyake enabled auto-merge (squash) November 7, 2022 10:38
@kenji-miyake kenji-miyake merged commit 5fba5a1 into main Nov 7, 2022
@kenji-miyake kenji-miyake deleted the update-markdownlint-config branch November 7, 2022 10:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants