Use Vale to lint docs writing #739
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: Rebecca Dimock <[email protected]>
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
frankharkins
requested review from
kt474 and
beckykd
and removed request for
kt474
kt474
reviewed
Mar 6, 2023
Pull Request Test Coverage Report for Build 4353319540
💛 - Coveralls |
frankharkins
commented
Mar 7, 2023
beckykd
approved these changes
Mar 7, 2023
kt474
pushed a commit
that referenced
this pull request
May 10, 2023
* Add writing linting with Vale * Lint docs using Vale rules Co-authored-by: Rebecca Dimock <[email protected]> * Add Vale tests to CI * Run black code formatting * Remove unneeded echo statements * Update PATH --------- Co-authored-by: Rebecca Dimock <[email protected]>
Eric-Arellano
pushed a commit
to Qiskit/documentation
that referenced
this pull request
Oct 6, 2023
* Add writing linting with Vale * Lint docs using Vale rules Co-authored-by: Rebecca Dimock <[email protected]> * Add Vale tests to CI * Run black code formatting * Remove unneeded echo statements * Update PATH --------- Co-authored-by: Rebecca Dimock <[email protected]>
Eric-Arellano
pushed a commit
to Qiskit/documentation
that referenced
this pull request
Oct 9, 2023
* Add writing linting with Vale * Lint docs using Vale rules Co-authored-by: Rebecca Dimock <[email protected]> * Add Vale tests to CI * Run black code formatting * Remove unneeded echo statements * Update PATH --------- Co-authored-by: Rebecca Dimock <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Uses Vale to lint writing in the docs. The most notable impact is the ability to catch spelling errors during CI, but this tool can also help enforce writing style rules.
To try it, install Vale and run
(you may also need to
pip install docutilsif you don't have it already).Most developers should be able to ignore this test (that is, no need to install Vale), and should only be impacted if a documentation change introduces an error, which is usually easily fixable.
Details and comments
The rules used are from IBM/ibm-quantum-style-guide.
Similar to pylint, you can turn off rules for specific sections using comments. Please make an issue if a rule is not working correctly so we can improve it.
How to read this PR
I've split this into three separate commits to make review easier:
In collaboration with @beckykd.