Change unordered marker from asterisk to dash #4
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
arcticicestudio
commented
Nov 15, 2018
arcticicestudio
commented
The previously used asterisk `*` have been changed to dashes `-`. The main reason is that asterisks `*` can be confused for bold/italic markers. There was also a very long discussion (1) for Prettier (2) to also change the default to dashes to same reasons which was then adapted (3). There are some other reasons like the alignment with the YAML spec which uses dashes for list items. This guide has now also adapted to this improvement by changing the default unordered list marker (4) from asterisks `*` to dashes `-`. References: (1) prettier/prettier#4251 (comment) (2) https://prettier.io (3) prettier/prettier#4440 (4) https://arcticicestudio.github.io/styleguide-markdown/rules/lists.html GH-3
arcticicestudio
changed the title
This version includes the changes of this improvement to ensure the linting stage is passing correctly. GH-3
arcticicestudio
deleted the
improvement/gh-3-unordered-marker-asterik-to-dash
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.