Merge pull request #149 from LilSpazJoekp/codebase-cleanup

Codebase cleanup

Author: LilSpazJoekp

.github/workflows/ci.yaml

@@ -22,11 +22,13 @@ jobs:
         with:
           enable-cache: true
       - name: Install dependencies
-        run: uv sync --group lint
+        run: uv sync --python-preference only-managed --group lint
       - name: Lint with pre-commit
         run: uv run pre-commit run --all-files
       - name: Run docstrfmt
-        run: uv run docstrfmt .
+        run: uv run docstrfmt
+      - name: Run pyright
+        run: uv run pyright -p pyproject.toml
     strategy:
       matrix:
         os: [ macOS-latest, ubuntu-latest, windows-latest ]
@@ -65,11 +67,10 @@ jobs:
         uses: astral-sh/setup-uv@v7
         with:
           enable-cache: true
-          python-version: ${{ matrix.python-version }}
       - name: Install dependencies
-        run: uv sync --group test --group ci
+        run: uv sync --python-preference only-managed --group test --group ci
       - name: Test with pytest
-        run: uv run coverage run --source docstrfmt --module pytest
+        run: uv run coverage run --source docstrfmt -m pytest
       - env:
           COVERALLS_PARALLEL: true
           COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}

AUTHORS.rst

@@ -1,9 +1,11 @@
-Maintainers
-===========
+#############
+ Maintainers
+#############
 
 - Joel Payne <lilspazjoekp@gmail.com> `@LilSpazJoekp <https://github.com/LilSpazJoekp>`_
 
-rstfmt Author
-=============
+###############
+ rstfmt Author
+###############
 
 - Danny Zhu <dzhu@dzhu.us> `@dzhu <https://github.com/dzhu>`_

CHANGES.rst

@@ -1,8 +1,10 @@
-Change Log
-==========
+############
+ Change Log
+############
 
-Unreleased
-----------
+************
+ Unreleased
+************
 
 **Added**
 
@@ -22,11 +24,8 @@ Unreleased
 
 **Fixed**
 
-- Fixed line length resolution order. The order is now:
-  1. Command line argument
-  2. ``pyproject.toml`` setting
-  3. Black config setting
-  4. Default of 88
+- Fixed line length resolution order. The order is now: 1. Command line argument 2.
+  ``pyproject.toml`` setting 3. Black config setting 4. Default of 88
 - Image and Unicode substitution definitions were not being formatted correctly.
 - Files specified in pyproject are now parsed correctly.
 - Fixed issue when loading cache in certain environments.
@@ -35,16 +34,18 @@ Unreleased
 
 - Removed support for Python 3.9.
 
-1.11.1 (2025/08/26)
--------------------
+*********************
+ 1.11.1 (2025/08/26)
+*********************
 
 **Fixed**
 
 - Fixed an issue where footnotes were getting malformed when using auto-numbering.
 - Switch to package ``roman`` for roman numeral parsing.
 
-1.11.0 (2025/08/15)
--------------------
+*********************
+ 1.11.0 (2025/08/15)
+*********************
 
 **Added**
 
@@ -70,8 +71,9 @@ Unreleased
 
 - Removed support for Python 3.8.
 
-1.10.0 (2025/02/25)
--------------------
+*********************
+ 1.10.0 (2025/02/25)
+*********************
 
 **Added**
 
@@ -87,8 +89,9 @@ Unreleased
   reported at once.
 - Fixed compatibility issue with Sphinx.
 
-1.9.0 (2024/08/26)
-------------------
+********************
+ 1.9.0 (2024/08/26)
+********************
 
 **Added**
 
@@ -104,8 +107,9 @@ Unreleased
 - Fix handling of ``.. code::`` blocks. They should now be correctly formatted to ``..
   code-block::``.
 
-1.8.0 (2024/07/28)
-------------------
+********************
+ 1.8.0 (2024/07/28)
+********************
 
 **Added**
 
@@ -117,8 +121,9 @@ Unreleased
 
 - Incorrect import of ``dataclass``.
 
-1.7.0 (2024/07/25)
-------------------
+********************
+ 1.7.0 (2024/07/25)
+********************
 
 **Added**
 
@@ -127,15 +132,17 @@ Unreleased
 - Added support for Sphinx metadata fields.
 - Added support for Sphinx Python directives.
 
-1.6.1 (2023/12/12)
-------------------
+********************
+ 1.6.1 (2023/12/12)
+********************
 
 **Fixed**
 
 - Fix incorrect blank line padding around ``:returns:`` and ``:raises:`` fields.
 
-1.6.0 (2023/12/10)
-------------------
+********************
+ 1.6.0 (2023/12/10)
+********************
 
 **Added**
 
@@ -159,15 +166,17 @@ Unreleased
 - Removed support for Python 3.6.
 - Removed support for Python 3.7.
 
-1.5.1 (2022/09/01)
-------------------
+********************
+ 1.5.1 (2022/09/01)
+********************
 
 **Fixed**
 
 - Fix ``ImportError`` when importing from black. Pinned black to 22.8.*.
 
-1.5.0 (2022/07/19)
-------------------
+********************
+ 1.5.0 (2022/07/19)
+********************
 
 **Added**
 
@@ -178,23 +187,26 @@ Unreleased
 - Fix ``AttributeError`` when accessing ``rawsource`` during the handling ``Text``
   nodes.
 
-1.4.4 (2022/02/06)
-------------------
+********************
+ 1.4.4 (2022/02/06)
+********************
 
 **Changed**
 
 - Bump maximum version of ``click`` from ``8.0.0`` to ``9.0.0``.
 - Bump minimum version of ``black`` to ``22``.
 
-1.4.3 (2021/11/19)
-------------------
+********************
+ 1.4.3 (2021/11/19)
+********************
 
 **Fixed**
 
 - An issue where docstrfmt would not properly find the ``pyproject.toml`` file.
 
-1.4.2 (2021/11/16)
-------------------
+********************
+ 1.4.2 (2021/11/16)
+********************
 
 **Changed**
 
@@ -204,37 +216,42 @@ Unreleased
 
 - An issue where the summary line of docstring was incorrectly wrapped.
 
-1.4.1 (2021/09/10)
-------------------
+********************
+ 1.4.1 (2021/09/10)
+********************
 
 **Added**
 
 - Add ``appdirs`` dependency.
 
-1.4.0 (2021/07/30)
-------------------
+********************
+ 1.4.0 (2021/07/30)
+********************
 
 **Added**
 
 - Add Pre-commit hooks.
 
-1.3.0 (2021/07/16)
-------------------
+********************
+ 1.3.0 (2021/07/16)
+********************
 
 **Added**
 
 - Add a check for blank fields and raise an error when found.
 - Add ``toml`` dependency.
 
-1.2.0 (2021/06/15)
-------------------
+********************
+ 1.2.0 (2021/06/15)
+********************
 
 **Added**
 
 - Add ability to specify config setting from ``pyproject.toml``.
 
-1.1.4 (2021/05/18)
-------------------
+********************
+ 1.1.4 (2021/05/18)
+********************
 
 **Changed**
 
@@ -244,8 +261,9 @@ Unreleased
 
 - Fix bug where exclude paths were not being excluded properly.
 
-1.1.3 (2021/05/10)
-------------------
+********************
+ 1.1.3 (2021/05/10)
+********************
 
 **Changed**
 
@@ -255,15 +273,17 @@ Unreleased
 
 - Fixed import error with sphinx>=4.0.0.
 
-1.1.2 (2021/05/04)
-------------------
+********************
+ 1.1.2 (2021/05/04)
+********************
 
 **Fixed**
 
 - Fixed issue when `target_version` is not set in `pyproject.toml`.
 
-1.1.1 (2021/05/04)
-------------------
+********************
+ 1.1.1 (2021/05/04)
+********************
 
 **Added**
 
@@ -277,16 +297,18 @@ Unreleased
 
 - Fixed import error when parsing black config.
 
-1.1.0 (2021/02/18)
-------------------
+********************
+ 1.1.0 (2021/02/18)
+********************
 
 - Make docstrfmt operate in parallel when processing more than 2 files similar to
   psf/black.
 - Added a caching mechanism similar to psf/black has so files that haven't changed from
   the last run won't be checked again.
 
-1.0.3 (2021/01/23)
-------------------
+********************
+ 1.0.3 (2021/01/23)
+********************
 
 **Added**
 
@@ -304,15 +326,17 @@ Unreleased
 - Bug where some raw docstrings were not being formatted.
 - Bug where some syntax errors in python blocks were not caught or raised correctly.
 
-1.0.2 (2020/12/27)
-------------------
+********************
+ 1.0.2 (2020/12/27)
+********************
 
 **Fixed**
 
 - Fix UnicodeEncodeError in Windows Github Actions jobs.
 
-1.0.1 (2020/12/27)
-------------------
+********************
+ 1.0.1 (2020/12/27)
+********************
 
 **Changed**
 
@@ -322,13 +346,15 @@ Unreleased
 
 - Fix encoding/decoding errors when opening files on Windows.
 
-1.0.0 (2020/12/26)
-------------------
+********************
+ 1.0.0 (2020/12/26)
+********************
 
 - First official docstrfmt release!
 
-1.0.0.pre0 (2020/12/26)
------------------------
+*************************
+ 1.0.0.pre0 (2020/12/26)
+*************************
 
 - Forked from `dzhu/rstfmt <https://github.com/dzhu/rstfmt>`_
 - Renamed to docstrfmt