Usage

Pre-commit

The package may be used as a pre-commit hook. Make sure to add it to your .pre-commit-config.yaml file as described in the Install section.

Command Line

To format the docstrings in a file using the command line interface, run:

g-docformatter file FILE_PATHS

Substitute FILE_PATHS with the path or paths to the file(s) to format.

Warning

This tool is intended to be ran after docformatter. Run docformatter on the file before running this tool. Failure to do this may cause docstring text to be deleted.