Add a docs linter - Githubissues

unitaryfund / mitiq

Mitiq is an open source toolkit for implementing error mitigation techniques on most current intermediate-scale quantum computers.

https://mitiq.readthedocs.io

GNU General Public License v3.0

359 stars 157 forks source link

Add a docs linter #2411

Closed purva-thakre closed 3 months ago

purva-thakre commented 3 months ago

Description

Fixes #2407

To check this action locally, install nvm in your local virtual environment.

Then, install markdownlint-cli using the provided instructions. Run markdownlint docs/ to find all the rule violations.

License

[ ] I license this contribution under the terms of the GNU GPL, version 3 and grant Unitary Fund the right to provide additional permissions as described in section 7 of the GNU GPL, version 3.

Before opening the PR, please ensure you have completed the following where appropriate.

[ ] I added unit tests for new code.
[ ] I used type hints in function signatures.
[ ] I used Google-style docstrings for functions.
[ ] I updated the documentation where relevant.
[ ] Added myself / the copyright holder to the AUTHORS file

codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 98.32%. Comparing base (bf82e84) to head (535248f). Report is 47 commits behind head on main.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #2411 +/- ## ======================================= Coverage 98.32% 98.32% ======================================= Files 87 87 Lines 4048 4048 ======================================= Hits 3980 3980 Misses 68 68 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

natestemen commented 3 months ago

I don't love the idea of adding node as a dependency to Mitiq. A simpler tool that can get us part of the way there is https://editorconfig.org/, and it's supported by almost all editors. Setting trim_trailing_whitespace to true would fix some of these issues. The drawback here is that this tool is not markdown specific.

purva-thakre commented 3 months ago

Closing this PR to cherry-pick the changes flagged by this extension with a different PR.