On Sat, Dec 11, 2021, 12:57 AM Stephen J. Turnbull <
stephenjturnb...@gmail.com> wrote:
Simão Afonso writes:
> On 2021-12-10 12:20:44, Ricky Teachey wrote:
> > 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"""
> >
> > Is this "global docstring" recognized by Sphinx as a docstring, too?
>
> My bad.
>
> Double checked and that's right, it is recognised as such.
To my mind Sphinx is sufficiently widely used that this settles the
"above or below" question.
Steve
I agree.
Even with this convention one could still accomplish separating the
documentation section from the definition section, like:
class Steel:
"""A simple material model of steel."""
# parameters
E_s: float
"the linear elastic modulus"
nu: float
"the poisson's ratio"
gamma: float
"the density"
# values
E_s = 29e6 # ksi
nu = 0.3
gamma = 490 # lbs per cu ft
As has already been observed, we already have something LIKE an attribute
docstring, which is an Annotated type hint object.
Should the bare docstring below the member become sugar for creating an
Annotated type hint?
x = 1
"spam"
Would then be equivalent to:
x: typing.Annotated[typing.Any, "spam"]
This seems really nice to me.
_______________________________________________
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/LO7KDBDFKKDI5XJJ7GE227PBTTM3D7NN/
Code of Conduct: http://python.org/psf/codeofconduct/
