diff --git a/source/python/docstrings.md b/source/python/docstrings.md index ba77d01..b50b66f 100644 --- 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 index b9b5a99..b004d4d 100644 --- a/source/python/linter.md +++ b/source/python/linter.md @@ -14,6 +14,6 @@ - see - ignore typing - - ignore all typing in one line: `# type: ignore` - - ignore specific error in one line: `# type: ignore[error-code]` - - + - ignore all typing in one line: `# type: ignore` + - ignore specific error in one line: `# type: ignore[error-code]` + -