Changelogs » Docstrfmt

PyUp Safety actively tracks 308,767 Python packages for vulnerabilities and notifies you when to upgrade.

Docstrfmt

1.1.2

------------------
  
  **Fixed**
  
  - Fixed issue when `target_version` is not set in `pyproject.toml`.

1.1.1

------------------
  
  **Added**
  
  - Added `currentmodule`, `function`, and `py:function` directives.
  
  **Changed**
  
  - Updated black config parsing.
  
  **Fixed**
  
  - Fixed import error when parsing black config.

1.1.0

------------------
  
  - 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

------------------
  
  **Added**
  
  - Support for asynchronous functions.
  - Ability to remove the blank line at the end of docstrings.
  
  **Changed**
  
  - Python file parsing now uses `libcst <https://libcst.readthedocs.io/en/latest>`_.
  - When misformatted files are found, location info is printed with the line where the
  error is found if possible.
  
  **Fixed**
  
  - 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

------------------
  
  **Fixed**
  
  - Fix UnicodeEncodeError in Windows Github Actions jobs.

1.0.1

------------------
  
  **Changed**
  
  - Open files with ``UTF-8`` encoding.
  
  **Fixed**
  
  - Fix encoding/decoding errors when opening files on Windows.

1.0.0

------------------
  
  - First official docstrfmt release!

1.0.0.pre0

-----------------------
  
  - Forked from `dzhu/rstfmt <https://github.com/dzhu/rstfmt>`_
  - Renamed to docstrfmt
  - Added ability to format Python docstrings
  - Switched to click for argument parsing
  - Formatted code with black
  - Made code easier to read
  - Added more rst constructs
  - Added more tests