[issue34261] Add description to clinic.py

Tim Hoffmann report at bugs.python.org
Sat Jul 28 08:47:29 EDT 2018


New submission from Tim Hoffmann <tim.hoffmann at posteo.de>:

When trying to update a docstring of a CPython builtin, I had problems finding out what Argument Clinic actually does.

First, I looked at the devguide, which does only mention that the clinic exists, but not what it does or how it's used.

Next, I tried "clinic.py --help". This unfortunately doesn't tell anything about itself.

The actual clinic doc is at https://docs.python.org/3/howto/clinic.html

To make the clinic a bit more discoverable, I propose a description including the link to clinic.py (see github #8518).

----------
components: Argument Clinic
messages: 322552
nosy: larry, timhoffm
priority: normal
pull_requests: 8039
severity: normal
status: open
title: Add description to clinic.py
versions: Python 3.8

_______________________________________
Python tracker <report at bugs.python.org>
<https://bugs.python.org/issue34261>
_______________________________________


More information about the Python-bugs-list mailing list