Rocksolid Light

News from da outaworlds

mail  files  register  groups  login

Message-ID:  

As to the Adjective: when in doubt, strike it out. -- Mark Twain, "Pudd'nhead Wilson's Calendar"

comp / comp.lang.python / Synchronise annotations -> docstring

SubjectAuthor
* Synchronise annotations -> docstringAlbert-Jan Roskam
`* Re: Synchronise annotations -> docstringStefan Ram
 `- Re: Synchronise annotations -> docstringAJ

1
Subject: Synchronise annotations -> docstring
From: Albert-Jan Roskam
Newsgroups: comp.lang.python
Date: Tue, 3 Sep 2024 21:49 UTC
References: 1
Path: eternal-september.org!news.eternal-september.org!feeder3.eternal-september.org!fu-berlin.de!uni-berlin.de!not-for-mail
From: sjeik_appie@hotmail.com (Albert-Jan Roskam)
Newsgroups: comp.lang.python
Subject: Synchronise annotations -> docstring
Date: Tue, 03 Sep 2024 23:49:09 +0200
Lines: 8
Message-ID: <mailman.30.1725400160.2917.python-list@python.org>
References: <DB9PR10MB6689AD99EB028EE443F5A42883932@DB9PR10MB6689.EURPRD10.PROD.OUTLOOK.COM>
Mime-Version: 1.0
Content-Type: text/plain; charset="utf-8"
X-Trace: news.uni-berlin.de RmJQRbJq1BxghClSCw4uxQNXflPcyIrMZPnll21hSwQA==
Cancel-Lock: sha1:aZbNBUgo4ITm/rYwu2UzlkKN88g= sha256:wsD2NpJBu0+LRQpvxemLSd90vlqzO+ViUNdaRiXaOyw=
Return-Path: <sjeik_appie@hotmail.com>
X-Original-To: python-list@python.org
Delivered-To: python-list@mail.python.org
Authentication-Results: mail.python.org; dkim=pass
reason="2048-bit key; unprotected key"
header.d=hotmail.com header.i=@hotmail.com header.b=UIXsxhLz;
dkim-adsp=pass; dkim-atps=neutral
X-Spam-Status: OK 0.005
X-Spam-Evidence: '*H*': 0.99; '*S*': 0.00; 'looks': 0.02; 'yet.':
0.04; 'received:eur05-am6-obe.outbound.protection.outlook.com':
0.07; 'received:40.92.91': 0.09; 'vim': 0.09; 'url:github': 0.14;
'to:addr:python-list': 0.20; 'thanks!': 0.24; 'tried': 0.26;
'but': 0.32; 'there': 0.33; 'tools': 0.74; 'strings': 0.84
ARC-Seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none;
b=agboyrQJsb4TrHyUOSuEGGGDIQ/xD6e7nAgClpBaQrecAFD1DJJtOgNAs2p17DpTvA7Ob/FvqwAgmM8FGZZ0xhJTkOiM3m5Pa0a6/b1GGUliH9EFam2UxmUo42vQY5tqPfyk9BVrVMm6Se6300qWflR13ZGxIqBvbVKodvKl1p/eIYEK474LFrUphcfP0J8mFGMInNW0TaTP3N5JNj8ChTJ44U+FArYyCBUzWXkwqPvcKWi9NXyDfPG0pRSzzXfH6GSZs1+JPvmgo14qzRp8rPchsmMf2w3AHtID+MoqDEC2BC+Xjk6wUHCLpF523jZA1E49IgjfU/gfUGqG/wfJ6w==
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com;
s=arcselector10001;
h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1;
bh=tJwKuX8yJrgw/Dcx8H/6nn0BYHZxeyzytkxgPKPWyzQ=;
b=XgMgZ7nOH6F4N/wrnE8aLQ/nH/SNuubP9bZF3y4m83qAblSYZ1YeqtcQdDqPF+Un2iYIOKAcvNqShraj8Twl078YmCoB78yRoXIeMhHfCG6IocjQAv8Eoq2dyVUKYGry6aAWX5YUL2EK9xR68dHLREM3F/d4P3+3YCEnxXFOUow6tDCIaz13A76jhNp3FSwHPwqasMC+qzn/gPjfuYzK9jrjqxrqTAY25pb8ui78wteTRo8rfhzToxaA9OX5CtYYKZ6jBZS9I50qn8SvHkZs75pVxAlACsHeesNzaWEyxHE7BhQ2f0bXYvlMWwkEG/K6yFE30CKgM7dxmpWtBGjKrw==
ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=none; dmarc=none;
dkim=none; arc=none
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=hotmail.com;
s=selector1;
h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck;
bh=tJwKuX8yJrgw/Dcx8H/6nn0BYHZxeyzytkxgPKPWyzQ=;
b=UIXsxhLzLH+s0BRcx5wjENXEmYVPlBYmEIV5jZdNR1ptRtRX+t4rSRY4MjCo5nohaWS75o8EViNdVhz49vA3gTG/WS6JxDFThRi3aQx5Lai2hj/7d4byb+1DzOZYwUSU7qNOUkSF1yrrihxVy+cTmUkKhiZBsjZ7mYwi3rEMojLu7VmD29trpqjv6o6zvdgiM/+y9BG3+RIQuCTPy61f++sJtucMkNmvrAScXRAeRg06FlCRw9Lm/muHeTdcmuMkFpHCS0D4cw0sXsAtnxfTrKStCrSXUCLOPEix4HuR0jWbpz6TeqsGd9xnCeSbeaOALYVbLRTCklcBcAR3JIpwng==
X-Android-Message-ID: <670d76d0-6bb3-4924-adaf-b06c5c1afad4@email.android.com>
X-TMN: [bNzXlKA7fUZ9Pteb+WBLxZQWxt+TtRZG]
X-ClientProxiedBy: AS4PR10CA0022.EURPRD10.PROD.OUTLOOK.COM
(2603:10a6:20b:5d8::6) To DB9PR10MB6689.EURPRD10.PROD.OUTLOOK.COM
(2603:10a6:10:3d3::21)
X-Microsoft-Original-Message-ID: <670d76d0-6bb3-4924-adaf-b06c5c1afad4@email.android.com>
X-MS-Exchange-MessageSentRepresentingType: 1
X-MS-PublicTrafficType: Email
X-MS-TrafficTypeDiagnostic: DB9PR10MB6689:EE_|DB9PR10MB7098:EE_
X-MS-Office365-Filtering-Correlation-Id: 809fc9f5-edea-4dd5-64b0-08dccc623fed
X-Microsoft-Antispam: BCL:0;
ARA:14566002|5072599009|461199028|15080799006|19110799003|8060799006|440099028|3412199025|4302099013|1602099012;
X-Microsoft-Antispam-Message-Info: jQAaBLSupANse9u6N3I2FZqfQYT9xjsdEBuFWLAKdt2lMSWmyhhSNday6+DdxrPUiCXNEII9qtx8H/fKApTo14SXDTnH8FpocsEAB3yJC4WU6rBtCVpp2J3ghbQZW/6eB4HqSh526Bq3DpXOI4iT+M3CdBYsuD1Lgo1CmEL409rL1GKugDlGTyuvsJrvPkEwautfKimlbWdQumIkoPnXjheyHlIxO/ZZVe6kX6dqBUPa2RKlcg/zmq1kF8MR2GkYyL7TsdK7T98LeguB6DzKr0xlOvCfcku9V+uFr/aitjZxV0K5h4cAliwhHVNF1Pbg3e+/KteXWbYl7GE+IbHQ4L9PvNsCk0D/6vpiP1lr6WGohcwIXvkKo0CaE8ill5tl16prGQ+sQ0UOxuP3VpfK0UX1As2v7ZwgK0en4FU3CJ3x1/9Yiwqq1aC1A3fmIGoke4KcaMSELfeToFn5h4m5+egs3RPhai+zy+89JIU4/CjDbnrKSTBF/A/JOwIBj92b5bQx529EkHFIQk2RqFl9RQGsvYUge8SZDzGibQpNEz+siv11jXCezGErBYTatAAlkNnkbr5qumegOsHJ0iuWDmfb4hrPvqbSRhEripZr76y6YqVKn3rFtl6yoTJw4ykrnrHH//0BPgjJIhzvqdGNBMkLC9VPvUVLeUzJvDHzxqB1Zxw1037aMz3obHHFJU/QOfE5mu0LcduYwIv8GuIgtvxDO27Bm+cxy1iNDI3JgZVdt3VRR1K7AgAiReq62vsO21HiHAuQQuxyDHF8tnKBwo3rCKpBjTm1i0TLCO2Pp6umjKImTMPnooNqIiOOF1Jl
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: ubxAkP7byH7d7tVkjQ70NxOapi7fUgHdNscxgqcod7SA+
d4OyuJ5fe7CUweSYf0WsVeim0dtktuqH8IdOGaqs5oo6K
JGTkrXH32nxX/Ak8dNseRvxEpYB/ZJrfxgLIXcmzXsUxW
NHKwKgMDFjTCxO6w23QlBCTcV2/Iz08R/lU6mS/jhFf5W
IGQZsnRFhxzvlj4ousRGCrJDBeWZDzJj3WGMIRkvfs7MO
exRAyWDSw7VHh1JgK2bXSFlymnD/sbixSv2HN4OyInGkb
XfFn5OXpHm+MQ1LDxUWWMnj6qqoVZem7Nak+NbhlBDIQy
MP41G31Wu72jpnYKqUUmBYWvWCgGghF5dGyCb0pNt5N/2
VgC2t3qBLCLhqsddHLOtN/ShK+8uJK0xu9sZUpKjcB7tN
CCKhfqsf0+x8udlQ/wibFuOvqqlAfCeJ/oWSAU2XcqcJT
Yo1ZaFrydlKxwAtx0xia1wrPTAtWsCdUStcRdttAYv2IC
2PX3wSUjv2m6ElYq1VEv/t85GYmIDI/WYOHVnRKlAsm/Y
IexRmzqbmHlC4marHfc7KUf3UetBr6lQaipDhgssHldnI
qQowAUBbtTmNN/W/eLQWiE+uY3AoIp9JWJO2ShzUS2kNw
Hnn2lsBFnKfxqN71B9GKdpKd2rDLAqwDhRzc6Gjcq7uyF
uY7Sf0f9k3Aqg8nuVaVvwg1lXu4sPA0iBo9KOtYgF2z7B
Rqx877kHuTEVBCgDr3ShdtTNFVdOMesl8KfYtN7UW5oaV
ZvRSo62NB1y3wB6SiCwQKvyiUnAMI0SQCd2dIRbKjphwV
kixk1nSlsvZ0z0ULx2yHYKlx21o/pFOv78+CUdPrgajv+
0mBVVNx+a/eH8f8TZRjyh9dAVwNkWNhIoZBdNH4F/A4wz
QznfIfsrnXBaw+eyunCvx/TVyEw/mk+jQIdc/FKGqI9jQ
i7CZWogZH+RVp2/t1arl1AJyRaV/uR8iNWdFfemaPjxuL
J7A+I64BOMDl+D/4uHDBF6TYIIgvytiSl8OA0M8gT0Xlp
DJhq17fZ9ejmQ7fe6579hvCZ4j+O2gPIj6qlGcIMGFOYG
MvDjMFrq15hbm3f8yYTVInq3hJQfWlavHtAZJzl+65QBG
B/SC8kEePuOQwxeJ6l3kCCKsiWfm0O3ldJkOJe+WAzUb/
5x5k3j50lCxvbgJvvCdZoLR8GaohmNKHfjXtcBeWoJL3I
KbmEkV+/MtFVNLo/vVZSxYAYcGrSHAd7hZmVz4TLg7I8=
X-OriginatorOrg: sct-15-20-7719-20-msonline-outlook-4359a.templateTenant
X-MS-Exchange-CrossTenant-Network-Message-Id: 809fc9f5-edea-4dd5-64b0-08dccc623fed
X-MS-Exchange-CrossTenant-AuthSource: DB9PR10MB6689.EURPRD10.PROD.OUTLOOK.COM
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 03 Sep 2024 21:49:13.7986 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 84df9e7f-e9f6-40af-b435-aaaaaaaaaaaa
X-MS-Exchange-CrossTenant-RMS-PersistedConsumerOrg: 00000000-0000-0000-0000-000000000000
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DB9PR10MB7098
X-Content-Filtered-By: Mailman/MimeDel 2.1.39
X-BeenThere: python-list@python.org
X-Mailman-Version: 2.1.39
Precedence: list
List-Id: General discussion list for the Python programming language
<python-list.python.org>
List-Unsubscribe: <https://mail.python.org/mailman/options/python-list>,
<mailto:python-list-request@python.org?subject=unsubscribe>
List-Archive: <https://mail.python.org/pipermail/python-list/>
List-Post: <mailto:python-list@python.org>
List-Help: <mailto:python-list-request@python.org?subject=help>
List-Subscribe: <https://mail.python.org/mailman/listinfo/python-list>,
<mailto:python-list-request@python.org?subject=subscribe>
X-Mailman-Original-Message-ID: <DB9PR10MB6689AD99EB028EE443F5A42883932@DB9PR10MB6689.EURPRD10.PROD.OUTLOOK.COM>
View all headers

Hi,
Are there any tools that check whether type annotations and Numpydoc
strings are consistent?
I did find this Vim
plugin: https://lxyuan0420.github.io/posts/til-vim-pydocstring-plugin.
Looks incredibly useful, but I haven't tried it yet.
Thanks!
AJ

Subject: Re: Synchronise annotations -> docstring
From: Stefan Ram
Newsgroups: comp.lang.python
Organization: Stefan Ram
Date: Tue, 3 Sep 2024 22:21 UTC
References: 1
Path: eternal-september.org!news.eternal-september.org!feeder3.eternal-september.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
View all headers

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.

Subject: Re: Synchronise annotations -> docstring
From: AJ
Newsgroups: comp.lang.python
Organization: A noiseless patient Spider
Date: Sun, 15 Sep 2024 09:12 UTC
References: 1 2
Path: eternal-september.org!news.eternal-september.org!.POSTED!not-for-mail
From: sjeik.appie@gmail.com (AJ)
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>
View all headers

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.

1

rocksolid light 0.9.8
clearnet tor