devguide icon indicating copy to clipboard operation
devguide copied to clipboard

Argument clinic: outdated tutorial

Open eltoder opened this issue 2 years ago • 1 comments

Documentation

The tutorial for Argument Clinic in the devguide contains an outdated section. It still describes the early implementation that used to generate calls to PyArg_ParseTuple*() functions. This is no longer the case.

The affected section starts with "First, ensure both places use the same argument-parsing function." and goes for a few paragraphs until "If any of these items differ in any way, adjust your Argument Clinic function specification and rerun Tools/clinic/clinic.py until they are the same."

Given that the output is now very different, this is quite confusing to read. The section probably needs to be completely rewritten.

CC @AlexWaygood @erlend-aasland

eltoder avatar Dec 21 '23 16:12 eltoder

Thanks for the report; do you want to propose a PR?

erlend-aasland avatar Dec 22 '23 10:12 erlend-aasland