Path: ...!uucp.uio.no!fnord.no!news1.firedrake.org!fu-berlin.de!uni-berlin.de!not-for-mail
From: ram@zedat.fu-berlin.de (Stefan Ram)
Newsgroups: comp.lang.python
Subject: Re: Synchronise annotations -> docstring
Date: 3 Sep 2024 22:21:46 GMT
Organization: Stefan Ram
Lines: 12
Expires: 1 Jul 2025 11:59:58 GMT
Message-ID: <consistency-20240903232108@ram.dialup.fu-berlin.de>
References: <mailman.30.1725400160.2917.python-list@python.org>
Mime-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
X-Trace: news.uni-berlin.de Mk7yCCMHSqzLyeN9uKXeawQXOC3hogZxjMXUhQPC3jbb5r
Cancel-Lock: sha1:NkHYqL2G4HrApIiRyjBeUfCMHHM= sha256:ynup4MvXLnh8dp5rSdtQ1uFvSzI/RKL6QyBsz7dHrwI=
X-Copyright: (C) Copyright 2024 Stefan Ram. All rights reserved.
	Distribution through any means other than regular usenet
	channels is forbidden. It is forbidden to publish this
	article in the Web, to change URIs of this article into links,
        and to transfer the body without this notice, but quotations
        of parts in other Usenet posts are allowed.
X-No-Archive: Yes
Archive: no
X-No-Archive-Readme: "X-No-Archive" is set, because this prevents some
	services to mirror the article in the web. But the article may
	be kept on a Usenet archive server with only NNTP access.
X-No-Html: yes
Content-Language: en-US
Bytes: 1858

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.