Skip to content

Commit 5d1661b

Browse files
jorgepilotoPipKat
andcommitted
Apply suggestions from code review
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
1 parent 1258994 commit 5d1661b

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

doc/source/doc-style/docstrings.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -44,16 +44,16 @@ PyAnsys libraries, adhere to the additional style guidelines that follow.
4444

4545
Short Summary
4646
-------------
47-
This is a single-line which goes right after the declaration of the function or
48-
class and provides a quick overview about the final goal of the code. The
49-
``short summary`` is mandatory. If not present, :ref:`Doc Style Tools` will
47+
This is a single-line that goes right after the declaration of the class or
48+
function for briefly describing what the class or function or does. The
49+
`short summary` is mandatory. If it is not present, :ref:`Doc Style Tools` will
5050
raise an error.
5151

5252
The short summary can be declared on the same line as the opening quotes or on
53-
the next line. Both ways are accepted by `PEP 257
54-
<https://peps.python.org/pep-0257>`_ but you must be consistent across your
55-
project. In case you decide to declare the short summary on the same line,
56-
please refer to :ref:`Numpydoc Validation`, as ``"GL01"`` check needs to be
53+
the next line. While `PEP 257
54+
<https://peps.python.org/pep-0257>`_ accepts both ways, you must be consistent across your
55+
project. If you decide to declare the short summary on the same line,
56+
refer to :ref:`Numpydoc Validation` because the ``"GL01"`` check needs to be
5757
disabled.
5858

5959
Depending in whether you are documenting a ``Class`` or a ``function``, you will

0 commit comments

Comments
 (0)