On Fri, Dec 10, 2021, 6:08 AM Simão Afonso <simao.afo...@powertools-tech.com> wrote:
> On 2021-12-09 12:47:28, Paul Bryan wrote: > > On Thu, 2021-12-09 at 19:01 +0000, Simão Afonso wrote: > > > I'm using docstrings bellow the attributes (analogous to functions > > > and > > > classes), I think it works well. > > > It helps with distinguishing the class docstring from the arguments. > > > > I think you'll find on close inspection that those strings don't "go > > anywhere" (i.e. they're not in help documentation, they're not > > introspectable.) > > Wow, that's right, I stand corrected. > > They do appear on Sphinx auto-generated documentation, so I assumed it > was a regular annotation, like classes and functions. > 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? >
_______________________________________________ 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/U5D53FEEDHL6WXCQHTCOSTR3FTYQAVF6/ Code of Conduct: http://python.org/psf/codeofconduct/
