Fix markdown issues raised by markdownlint#344
Open
kianmeng wants to merge 1 commit intoWhatsApp:mainfrom
Open
Fix markdown issues raised by markdownlint#344kianmeng wants to merge 1 commit intoWhatsApp:mainfrom
kianmeng wants to merge 1 commit intoWhatsApp:mainfrom
Conversation
facebook-github-bot
added
the
CLA Signed
| Here is an example of building with erlang version 22 on mac: | ||
|
|
||
| ```bash | ||
| $ brew install erlang@22 |
Contributor
There was a problem hiding this comment.
Here the dollars vs hashtags are kind of important
Contributor
Author
There was a problem hiding this comment.
Agree, hashtags are comments, revert changes.
|
|
||
| ```bash | ||
| $ mkdir -p ~/.config/rebar3/ && echo "{plugins, [rebar3_hex]}." >> ~/.config/rebar3/rebar.config | ||
| mkdir -p ~/.config/rebar3/ && echo "{plugins, [rebar3_hex]}." >> ~/.config/rebar3/rebar.config |
Contributor
There was a problem hiding this comment.
Same here the dollar indicates the command to run and the non dollar indicates the output
Contributor
Author
There was a problem hiding this comment.
RELEASE.md:52:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ mkdir -p ~/.config/rebar3/ &..."]
| ### Booleans | ||
|
|
||
| * avoid `and` and `or` operators, prefer` andalso` and `orelse`, or | ||
| * avoid `and` and `or` operators, prefer `andalso` and `orelse`, or |
Contributor
awalterschulze
left a comment
awalterschulze
left a comment
There was a problem hiding this comment.
In general I am against removing the $ and # from verbatim text. Otherwise it looks like an improvement. Pretty nice tool :)
Ran against this command:
markdownlint *.md doc/*.md --disable MD013 MD034 MD010 MD051 MD024 MD029
See a detailed description of the rules is available at
https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md
kianmeng
force-pushed
the
fix-markdown-issues
branch
from
5e73996 to
900b373
Compare
Contributor
|
I would keep the If @michalmuskala thinks removing the |
Contributor
Author
|
@michalmuskala Any updates on this PR? |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Ran against this command:
See a detailed description of the rules is available at
https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md