Skip to content

manual.md: Fix markdown lint warnings.#1773

Merged
versat merged 1 commit into
cppcheck-opensource:masterfrom
versat:manual_lint_fixes
Apr 3, 2019
Merged

manual.md: Fix markdown lint warnings.#1773
versat merged 1 commit into
cppcheck-opensource:masterfrom
versat:manual_lint_fixes

Conversation

@versat
Copy link
Copy Markdown
Collaborator

@versat versat commented Apr 1, 2019

No description provided.

@versat versat requested a review from danmar April 1, 2019 09:40
@amai2012
Copy link
Copy Markdown
Collaborator

amai2012 commented Apr 1, 2019

Could travis run markdownlint? Or is this already implemented?

@versat
Copy link
Copy Markdown
Collaborator Author

versat commented Apr 1, 2019

Could travis run markdownlint? Or is this already implemented?

It should be possible. It is not yet implemented.
The package "ruby" must be installed.
Then "mdl" (for markdownlint) must be installed via sudo gem install mdl.
The manual then can be checked with mdl man/manual.md.
Additionally we should provide a rule file (called "style file") since not all rules should be enforced i guess.

@versat
Copy link
Copy Markdown
Collaborator Author

versat commented Apr 1, 2019

Codacy uses RemarkLint with other settings and warnings :)
Not sure what style and linter we should use.
Edit:
I have looked into the RemarkLint configuration in Codacy.
RemarkLint recommends very similar things as markdownlint.
The issues that RemarkLint outputs for the indentation of bullet list contents do not really make sense to me.
It wants bullet list to look like this

-   Text 1
-   Text 2

Instead of

- Text 1
- Text 2

The indentation is set to tab-size which seems to be set to 4. IMHO the space setting makes more sense here.

@versat versat force-pushed the manual_lint_fixes branch from 95915e1 to 034a356 Compare April 1, 2019 11:29
@versat versat changed the title manual.md: Fix markdown lint warnings and one wrong code indentation. manual.md: Fix markdown lint warnings. Apr 1, 2019
@versat
Copy link
Copy Markdown
Collaborator Author

versat commented Apr 3, 2019

@danmar Are you ok with these changes?

Copy link
Copy Markdown
Collaborator

@danmar danmar left a comment

Choose a reason for hiding this comment

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

lgtm

@versat versat merged commit d8d4ca5 into cppcheck-opensource:master Apr 3, 2019
@versat versat deleted the manual_lint_fixes branch April 3, 2019 18:05
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.

3 participants