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 :ref:`Install <install>` section.


Command Line
------------

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

.. code-block:: bash

    g-docformatter file FILE_PATHS

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