Sujet : Re: Synchronise annotations -> docstring
De : sjeik.appie (at) *nospam* gmail.com (AJ)
Groupes : comp.lang.pythonDate : 15. Sep 2024, 11:12:32
Autres entêtes
Organisation : A noiseless patient Spider
Message-ID : <vc68e0$23asp$1@dont-email.me>
References : 1 2
User-Agent : PhoNews/3.13.3 (Android/13)
On 9/4/24 00:21,
ram@zedat.fu-berlin.de wrote:
Albert-Jan Roskam <sjeik_appie@hotmail.com> wrote or quoted:
Are there any tools that check whether type annotations and Numpydoc
strings are consistent?
>
According to one webpage, the "sphinx-autodoc-typehints" extension
lets you roll with Python 3 annotations for documenting the types
of arguments and return values of functions. >
So, you'd have a "single source of truth" again to keep everything
chill and straightforward.
>
>
Thanks, I'll have a look. I'm currently using pdoc (or was it pdoc3?) but I
could go back to Sphinx. I like Markdown better than restructuredText,
though.