I don't see a contradiction? The note says to use "return" instead of
"returns", and the docstring example uses "return".
> On Dec 29, 2020, at 8:58 PM, Paul Graves-DesLauriers <p...@dexmicro.com>
> wrote:
>
> I would like clarification about the one-line docstring example.
>
> The Notes say (fourth bullet):
> The docstring is a phrase ending in a period. It prescribes the function or
> method's effect as a command ("Do this", "Return that"), not as a
> description; e.g. don't write "Returns the pathname ...".
>
> However the docstring example for kos_root() is: “””Return the pathname of
> the KOS root directory.”””
>
> I’ve highlighted the areas that seem to contradict each other. Perhaps the
> example should be updated to conform to the notes?
_______________________________________________
Doc-SIG maillist - Doc-SIG@python.org
https://mail.python.org/mailman/listinfo/doc-sig
