Use reStructuredText-style docstrings
commit635d316b14db6ed69938bac909e599951557e8bb
authorPeter Grayson <pete@jpgrayson.net>
Sat, 30 Jan 2021 22:12:59 +0000 (30 17:12 -0500)
committerPeter Grayson <pete@jpgrayson.net>
Sat, 6 Feb 2021 21:39:36 +0000 (6 16:39 -0500)
tree4bf5b08a18abdd2455157eb880987aee0d9882b0
parentcd98b4e726d641e880bb336fe853f2f8eee9f4ee
Use reStructuredText-style docstrings

Docstrings were previously written in the epytext style. ReStructuredText
is more widely used in Python projects and has compelling tooling options.
Mostly, however, this suits this author's preference for readability and
maintenance.

All docstrings are updated to reStructuredText and many are improved with
edits.

Signed-off-by: Peter Grayson <pete@jpgrayson.net>
24 files changed:
stgit/argparse.py
stgit/commands/clone.py
stgit/commands/common.py
stgit/commands/diff.py
stgit/commands/refresh.py
stgit/config.py
stgit/exception.py
stgit/lib/edit.py
stgit/lib/git/base.py
stgit/lib/git/branch.py
stgit/lib/git/date.py
stgit/lib/git/iw.py
stgit/lib/git/objects.py
stgit/lib/git/person.py
stgit/lib/git/repository.py
stgit/lib/log.py
stgit/lib/objcache.py
stgit/lib/stack.py
stgit/lib/stackupgrade.py
stgit/lib/transaction.py
stgit/main.py
stgit/run.py
stgit/templates.py
stgit/utils.py