Synchronise annotations -> docstring
AJ
sjeik.appie at gmail.com
Sun Sep 15 05:12:32 EDT 2024
On 9/4/24 00:21, ram at zedat.fu-berlin.de wrote:
>Albert-Jan Roskam <sjeik_appie at 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.
More information about the Python-list
mailing list