Document Argument Clinic

[vstinner]

BPO	19659
Nosy	@brettcannon, @ncoghlan, @pitrou, @vstinner, @larryhastings

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = 'https://github.com/larryhastings'
closed_at = <Date 2014-01-04.20:45:59.869>
created_at = <Date 2013-11-20.00:24:40.960>
labels = ['build']
title = 'Document Argument Clinic'
updated_at = <Date 2014-01-05.02:21:33.097>
user = 'https://github.com/vstinner'

bugs.python.org fields:

activity = <Date 2014-01-05.02:21:33.097>
actor = 'larry'
assignee = 'larry'
closed = True
closed_date = <Date 2014-01-04.20:45:59.869>
closer = 'larry'
components = ['Build', 'Demos and Tools']
creation = <Date 2013-11-20.00:24:40.960>
creator = 'vstinner'
dependencies = []
files = []
hgrepos = []
issue_num = 19659
keywords = []
message_count = 9.0
messages = ['203452', '203854', '203859', '203893', '203923', '207309', '207310', '207312', '207329']
nosy_count = 6.0
nosy_names = ['brett.cannon', 'ncoghlan', 'pitrou', 'vstinner', 'larry', 'python-dev']
pr_nums = []
priority = 'critical'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue19659'
versions = ['Python 3.4']

[vstinner]

While modifying zlibmodule.c, Serhiy told me that argument clinic is now used in zlibmodule.c. Running "./python Tools/clinic/clinic.py -f Modules/zlibmodule.c" does modify the file, so I misuse argument clinic.

I saw Argument Clinic on Youtube but it didn't help...
http://www.youtube.com/watch?v=kQFKtI6gn9Y

Would it be possible to explain how to use clinic.py, explain the format, etc. in the Python documentation? Somewhere near Doc/c-api/.

[pitrou]

I think this is really necessary at some point.
How to start writing a function with Argument Clinic, etc.

[larryhastings]

I quite agree. My plan is to write a quick HOWTO for now to get
people up and running for now, then flesh it out into a full document.
But I'm working like crazy right now to get a couple things done
before beta.

[vstinner]

I quite agree. My plan is to write a quick HOWTO for now to get
people up and running for now, then flesh it out into a full document.

Oh yes, I prefer a practical doc based on examples rather a full reference of the API.

[ncoghlan]

While it's still a private tool, something in the dev guide would be
appropriate, then it can be promoted to the regular docs if it becomes a
public capability in 3.5.

[python-dev]

New changeset e2280bf5c263 by Larry Hastings in branch 'default':
Issue bpo-19659: Added documentation for Argument Clinic.
http://hg.python.org/cpython/rev/e2280bf5c263

[larryhastings]

I hid it in the howto directory. Nobody'll look in there! :D

[pitrou]

I hid it in the howto directory. Nobody'll look in there! :D

I think using a dotfile would make the hiding more efficient.

[larryhastings]

Doesn't help on Windows, junior!