mdformat

PhilipMay · Jan 2, 2024 · 87c02eb · 87c02eb
1 parent 1998dce
commit 87c02eb
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/source/python/docstrings.md b/source/python/docstrings.md
@@ -18,9 +18,9 @@
 
 ### Cross-referencing Python objects
 
-- function: ``:func:`module_name.function_name` ``
-- class: ``:class:`module_name.ClassName` ``
-- meth: ``:meth:`module_name.ClassName.method_name` ``
+- function: `` :func:`module_name.function_name` ``
+- class: `` :class:`module_name.ClassName` ``
+- meth: `` :meth:`module_name.ClassName.method_name` ``
 - prefix `~`: link text will only be the last component of the target
 - also see: [Cross-referencing syntax](https://www.sphinx-doc.org/en/master/usage/domains/index.html#cross-referencing-syntax)
 - also see: [Cross-referencing Python objects](https://www.sphinx-doc.org/en/master/usage/domains/python.html#cross-referencing-python-objects)

diff --git a/source/python/linter.md b/source/python/linter.md
@@ -14,6 +14,6 @@
 
 - see <https://mypy.readthedocs.io/en/stable/>
 - ignore typing
-    - ignore all typing in one line: `# type: ignore`
-    - ignore specific error in one line: `# type: ignore[error-code]`
-    - <https://mypy.readthedocs.io/en/stable/common_issues.html#spurious-errors-and-locally-silencing-the-checker>
+  - ignore all typing in one line: `# type: ignore`
+  - ignore specific error in one line: `# type: ignore[error-code]`
+  - <https://mypy.readthedocs.io/en/stable/common_issues.html#spurious-errors-and-locally-silencing-the-checker>