diff options
author | Adam Turner <9087854+aa-turner@users.noreply.github.com> | 2022-02-20 02:57:02 +0000 |
---|---|---|
committer | Adam Turner <9087854+aa-turner@users.noreply.github.com> | 2022-02-20 02:57:02 +0000 |
commit | b691ebcc3e440a678cd28432fed7279fa647e9cd (patch) | |
tree | faa2103fb21a8e51ea0dfe735c43bd4ed1071e13 /sphinx/util/docfields.py | |
parent | 5694e0ce60316b9cb9709d147e1a699ea9bde6da (diff) | |
download | sphinx-git-b691ebcc3e440a678cd28432fed7279fa647e9cd.tar.gz |
Conform to PEP 257 summary line conventions
Diffstat (limited to 'sphinx/util/docfields.py')
-rw-r--r-- | sphinx/util/docfields.py | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/sphinx/util/docfields.py b/sphinx/util/docfields.py index 81887126a..6617465da 100644 --- a/sphinx/util/docfields.py +++ b/sphinx/util/docfields.py @@ -1,4 +1,6 @@ -""""Doc fields" are reST field lists in object descriptions that will +"""Utility code for "Doc fields". + +"Doc fields" are reST field lists in object descriptions that will be domain-specifically transformed to a more appealing presentation. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. |