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

Fix markdown issues raised by markdownlint #344

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

kianmeng
Copy link
Contributor

@kianmeng kianmeng commented Aug 6, 2022

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

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Aug 6, 2022
```bash
$ brew install erlang@22
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here the dollars vs hashtags are kind of important

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here the dollar indicates the command to run and the non dollar indicates the output

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catch here

Copy link
Member

@awalterschulze awalterschulze left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
@awalterschulze
Copy link
Member

I would keep the $s everywhere, but otherwise I would accept.

If @michalmuskala thinks removing the $s are fine, then I don't object to merging.

@kianmeng
Copy link
Contributor Author

@michalmuskala Any updates on this PR?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants