From 296043dd2a101aba55376c19ae309d83fb7ff2e0 Mon Sep 17 00:00:00 2001 From: Matt Gebert Date: Wed, 18 Dec 2024 22:34:16 +1100 Subject: [PATCH] doc(doc/format.rst): Grammar Co-authored-by: Stefan van der Walt --- doc/format.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/format.rst b/doc/format.rst index c1a077c1..ecdd1d4f 100644 --- a/doc/format.rst +++ b/doc/format.rst @@ -558,7 +558,7 @@ Use the same sections as outlined above (all except :ref:`Returns ` are applicable). The constructor (``__init__``) should also be documented here, the :ref:`Parameters ` 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 `