On Fri, Dec 10, 2021 at 11:46 AM Simão Afonso <
simao.afo...@powertools-tech.com> wrote:
> On 2021-12-10 08:20:25, Ricky Teachey wrote:
> > Very very interesting that Sphinx already treats a bare string under the
> > parameter as documentation! I had no idea. Does it do the same thing at
> the
> > module level?
>
> Yes.
>
> > $ cat module.py
> > """This is the module docs"""
> >
> > class CLS:
> > """CLS docs"""
> >
> > attr: int
> > """CLS.attr doc"""
I meant to ask about a (global) module member, not the module docstring
itself. Like MY_GLOBAL below:
"""This is the module docs"""
MY_GLOBAL = None
"""MY_GLOBAL docs"""
class CLS:
"""CLS docs"""
attr: int
"""CLS.attr doc"""
Is this "global docstring" recognized by Sphinx as a docstring, too?
---
Ricky.
"I've never met a Kentucky man who wasn't either thinking about going home
or actually going home." - Happy Chandler
_______________________________________________
Python-ideas mailing list -- python-ideas@python.org
To unsubscribe send an email to python-ideas-le...@python.org
https://mail.python.org/mailman3/lists/python-ideas.python.org/
Message archived at
https://mail.python.org/archives/list/python-ideas@python.org/message/643W2H5YJZN7G5AAQUE4HL7VCAERVEUF/
Code of Conduct: http://python.org/psf/codeofconduct/
