-
Notifications
You must be signed in to change notification settings - Fork 49
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.
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
Refactor out woke instructions #158
Merged
Merged
Changes from 8 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
ddd2a3a
Refactor out woke instructions
f773132
Edits as per review
6c88e19
Spelling
1d2c761
Fix inclusive language check failure
2773874
Fix spelling check failure
e17f3e0
Fix woke stuff
f264cb8
Fix more woke stuff
7553d1d
Even more fixups
4749735
Edits as per review
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -44,3 +44,4 @@ UI | |
UUID | ||
VM | ||
YAML | ||
wokeignore | ||
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
=================================== | ||
Inclusive language check exemptions | ||
=================================== | ||
|
||
This page provides an overview of two inclusive language check exemption | ||
methods for files written in reST format. See the `woke documentation`_ for | ||
full coverage. | ||
|
||
Exempt a word | ||
------------- | ||
|
||
To exempt an individual word, place a custom ``none`` role (defined in the | ||
``canonical-sphinx-extensions`` Sphinx extension) anywhere on the line | ||
containing the word in question. The role syntax is: | ||
|
||
.. code-block:: none | ||
|
||
:none:`wokeignore:rule=<SOME_WORD>,` | ||
|
||
For instance: | ||
|
||
.. code-block:: none | ||
|
||
This is your text. The word in question is here: whitelist. More text. :none:`wokeignore:rule=whitelist,` | ||
|
||
To exempt an element of a URL, it is recommended to use the standard reST | ||
method of placing links at the bottom of the page (or in a separate file). In | ||
this case, a comment line is placed immediately above the URL line. The comment | ||
syntax is: | ||
|
||
.. code-block:: none | ||
|
||
.. wokeignore:rule=<SOME_WORD> | ||
|
||
Here is an example where a URL element contains the string "master": :none:`wokeignore:rule=master,` | ||
|
||
.. code-block:: none | ||
|
||
.. LINKS | ||
.. wokeignore:rule=master | ||
.. _link definition: https://some-external-site.io/master/some-page.html | ||
|
||
You can now refer to the label ``link definition_`` in the body of the text. | ||
|
||
Here :none:`wokeignore:rule=master,` is an example where a URL element contains the string "master": | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Duplicate of line 35. |
||
|
||
Exempt an entire file | ||
--------------------- | ||
|
||
A more drastic solution is to make an exemption for the contents of an entire | ||
file. For example, to exempt file ``docs/foo/bar.rst`` add the following line | ||
to file ``.wokeignore``: | ||
|
||
.. code-block:: none | ||
|
||
foo/bar.rst | ||
|
||
.. LINKS | ||
.. _woke documentation: https://docs.getwoke.tech/ignore |
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not needed anymore.