Auto-format .md file

jsh9 · Aug 15, 2023 · 12abb68 · 12abb68
1 parent 8e0ccce
commit 12abb68
Showing 1 changed file with 9 additions and 4 deletions.
diff --git a/docs/how_to_ignore.md b/docs/how_to_ignore.md
@@ -1,6 +1,8 @@
-# How to ignore certain violations in *flake8* mode
+# How to ignore certain violations in _flake8_ mode
 
-In *flake8* mode (meaning that you use *pydoclint* as a flake8 plugin), if you'd like to ignore a specific violation code (such as `DOC201` and `DOC301`) in-line, you can add this comment to the function of your choice:
+In _flake8_ mode (meaning that you use _pydoclint_ as a flake8 plugin), if
+you'd like to ignore a specific violation code (such as `DOC201` and `DOC301`)
+in-line, you can add this comment to the function of your choice:
 
 ```python
 def my_function(  # noqa: DOC201, DOC301
@@ -10,7 +12,8 @@ def my_function(  # noqa: DOC201, DOC301
     ...
 ```
 
-If you would like to ignore certain categories of violations (such as `DOC2xx`) in-line, you can do this:
+If you would like to ignore certain categories of violations (such as `DOC2xx`)
+in-line, you can do this:
 
 ```python
 def my_function(  # noqa: DOC2
@@ -20,4 +23,6 @@ def my_function(  # noqa: DOC2
     ...
 ```
 
-All the usage is consistent with how you would use *flake8*.  Please read the official *flake8* documentation for full details: https://flake8.pycqa.org/en/latest/user/violations.html.
+All the usage is consistent with how you would use _flake8_. Please read the
+official _flake8_ documentation for full details:
+https://flake8.pycqa.org/en/latest/user/violations.html.