Skip to content

Mention linting #11445

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jul 3, 2024
Merged

Mention linting #11445

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f375fa9
Mention linting
plaindocs Jul 1, 2024
2bde762
Fix whitespace that the linter doesnt catch
plaindocs Jul 1, 2024
78c5ae0
Review fixes
plaindocs Jul 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/dev/style-guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,18 @@ Content
* ``:guilabel:`<your username>` dropdown``
* Make sure that **all bullet list items end with a period**, and don't mix periods with no periods.

Linting
~~~~~~~

ReStructuredText for both the RTD user documentation and this developer documentation is linted with `pre-commit` for broken links,
whitespace consistency, and other minor issues.

You can fix many linting issues automatically by installing and running `pre-commit` locally. To run it on content you have have already committed, use the ``--from-ref`` and ``--to-ref`` `flags <https://pre-commit.com/#pre-commit-run>`__.

```
❯ pre-commit run --from-ref <OLDER_COMMIT> --to-ref <RECENT_COMMIT>
```

Word list
---------

Expand Down
Loading