Path: ...!news.mixmin.net!eternal-september.org!feeder3.eternal-september.org!news.eternal-september.org!.POSTED!not-for-mail
From: AJ <sjeik.appie@gmail.com>
Newsgroups: comp.lang.python
Subject: Re: Synchronise annotations -> docstring
Date: Sun, 15 Sep 2024 09:12:32 -0000 (UTC)
Organization: A noiseless patient Spider
Lines: 18
Message-ID: <vc68e0$23asp$1@dont-email.me>
References: <mailman.30.1725400160.2917.python-list@python.org>
 <consistency-20240903232108@ram.dialup.fu-berlin.de>
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 8bit
Injection-Date: Sun, 15 Sep 2024 11:12:32 +0200 (CEST)
Injection-Info: dont-email.me; posting-host="6a8ec51c6d99924288c60037827ccbbe";
	logging-data="2206617"; mail-complaints-to="abuse@eternal-september.org";	posting-account="U2FsdGVkX18shxmEwbdU06HSrvW+YYUP"
User-Agent: PhoNews/3.13.3 (Android/13)
Cancel-Lock: sha1:RDJ0cfpYrKkhApVwA44i2Ph0uEM=
In-Reply-To: <consistency-20240903232108@ram.dialup.fu-berlin.de>
Bytes: 1756

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.