docs: add pymarkdownlnt to lint jobs#815
Conversation
pymarkdownlnt to lint jobs
`pymarkdownlnt` is a nice lib that lints markdown documents. It check for good formatting and standards managed by [CommonMark](https://spec.commonmark.org/). As proof of concept, the linter was applied only to the README.md.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #815 +/- ##
========================================
Coverage 97.31% 97.31%
========================================
Files 83 83
Lines 10576 10576
========================================
Hits 10292 10292
Misses 284 284 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
I think it's a great tool that contributors can spin locally and submit their results to the project. |
|
We can add only on CI then, or close |
|
I would repurpose the PR to lint files, the single one it targets now, or more, without adding weight to the project with tools and enforcements. It would be very welcome. |
What is this PR for?
pymarkdownlntis a nice lib that lints markdown documents. It check for good formatting and standards managed by CommonMark. As proof of concept, the linter was applied only to the README.md.Changes made to:
Did you build the code and tested on device?
What is the purpose of this pull request?