Skip to content

Commit

Permalink
doc(doc/format.rst): Grammar
Browse files Browse the repository at this point in the history
Co-authored-by: Stefan van der Walt <[email protected]>
  • Loading branch information
mattgebert and stefanv authored Dec 18, 2024
1 parent be2bd62 commit 296043d
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/format.rst
Original file line number Diff line number Diff line change
Expand Up @@ -558,7 +558,7 @@ Use the same sections as outlined above (all except :ref:`Returns <returns>`
are applicable). The constructor (``__init__``) should also be documented
here, the :ref:`Parameters <params>` section of the docstring details the
constructor's parameters. While repetition is unnecessary, a docstring for
the class constructor (``__init__``) can be added optionally to provide
the class constructor (``__init__``) can, optionally, be added to provide
detailed initialization documentation.

An **Attributes** section, located below the :ref:`Parameters <params>`
Expand Down

0 comments on commit 296043d

Please sign in to comment.