Docs: Add missing markup to Argument Clinic docs #106876

erlend-aasland · 2023-07-18T23:24:41Z

Add :py:func:, :c:func:, etc. where appropriate
Remove repeated links within the same paragraph

📚 Documentation preview 📚: https://cpython-previews--106876.org.readthedocs.build/

- Add :py:func:, :c:func:, etc. where appropriate - Remove repeated links within the same paragraph

erlend-aasland · 2023-07-18T23:27:16Z

I'm slightly unsure about the :program: markups. For the rest, it is nice with proper formatting and a couple of more links. There's probably some more cases where parameters should be wrapped in a pair of *, but this was all I had time for now.

Doc/howto/clinic.rst

serhiy-storchaka

LGTM in general.

Be aware, there is the concrete function PyArg_Parse(), and there is a family of functions PyArg_Parse*(). This document may use the former in the meaning of the latter.

Doc/howto/clinic.rst

erlend-aasland · 2023-07-19T08:48:02Z

Thank you so much for the (initial) reviews, Ezio and Serhiy; highly appreciated. I will go through your remarks later today.

- line 166: link to pickle.Pickler.dump - line 187: markup PyArg_Parse* - line 580: link to pickle.Pickler.dump - line 891: revert Py_buffer change - line 919: markup PyArg_Parse - line 973: markup sys.maxsize as :data: - line 1008: markup sys.modules as :data: - markup CConverter and it's attributes as a proper Python class

erlend-aasland · 2023-07-19T11:10:11Z

@serhiy-storchaka and @ezio-melotti: I've addressed some remarks in 6e5c44f

…inic directly

…ning clinic directly

erlend-aasland · 2023-07-20T08:40:09Z

With 47061df, I think I've addressed all your remarks, @ezio-melotti.

erlend-aasland · 2023-07-22T20:55:24Z

@serhiy-storchaka, I believe I've addressed your review comments.

erlend-aasland · 2023-07-24T13:28:33Z

I believe all review remarks have been addressed, so I'm going to land this today. Thanks again for the reviews!

Doc/howto/clinic.rst

miss-islington · 2023-07-24T15:22:22Z

Thanks @erlend-aasland for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

miss-islington · 2023-07-24T15:22:29Z

Sorry, @erlend-aasland, I could not cleanly backport this to 3.11 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker ff5f94b72c8aad8e45c397c263dbe7f19221735f 3.11

bedevere-bot · 2023-07-24T15:22:29Z

GH-107181 is a backport of this pull request to the 3.12 branch.

(cherry picked from commit ff5f94b) Co-authored-by: Erlend E. Aasland <erlend@python.org> Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>

…107181) (cherry picked from commit ff5f94b) Co-authored-by: Erlend E. Aasland <erlend@python.org> Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>

bedevere-bot · 2023-07-24T15:36:17Z

GH-107182 is a backport of this pull request to the 3.11 branch.

(cherry picked from commit ff5f94b) Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>

…07182) (cherry picked from commit ff5f94b) Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>

* main: (73 commits) Thoroughly refactor the cases generator (python#107151) Docs: Add missing markup to Argument Clinic docs (python#106876) pythongh-107162: Document errcode.h usage in its comment (python#107177) pythongh-106320: Remove private _PyDict C API (python#107145) Fix PyVectorcall_Function doc versionadded (python#107140) Docs: Remove duplicate word in Argument Clinic howto heading (python#107169) pythongh-107017: Change Chapter Strings to Texts in the Introduction chapter. (python#107104) pythongh-106320: Remove private _PyObject C API (python#107159) Docs: fix typo in os.pwrite docstring (python#107087) pythongh-105291: Add link to migration guide for distutils (python#107130) pythongh-106948: Docs: Disable links for C standard library functions, OS utility functions and system calls (python#107062) pythongh-106320: Remove _PyBytes_Join() C API (python#107144) pythongh-106320: Remove private _PyObject C API (python#107147) pythongh-106320: Remove _PyTuple_MaybeUntrack() C API (python#107143) pythongh-106320: Remove _PyIsSelectable_fd() C API (python#107142) Remove superflous whitespaces in `layout.html`. (pythonGH-107067) pythongh-107122: Update what's news for dbm.*dbm.clear() method (pythongh-107135) pythongh-107122: Add clear method to dbm.ndbm module (pythongh-107126) pythongh-62519: Make pgettext search plurals when translation is not found (python#107118) pythongh-107122: Add clear method to dbm.gdbm.module (pythongh-107127) ...

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>

Docs: Add missing markup to Argument Clinic docs

e8068e0

- Add :py:func:, :c:func:, etc. where appropriate - Remove repeated links within the same paragraph

erlend-aasland added skip issue skip news needs backport to 3.11 only security fixes needs backport to 3.12 bug and security fixes labels Jul 18, 2023

erlend-aasland requested a review from ezio-melotti July 18, 2023 23:24

bedevere-bot added awaiting core review docs Documentation in the Doc dir labels Jul 18, 2023

Add missing colon

cf66105

ezio-melotti reviewed Jul 19, 2023

View reviewed changes

serhiy-storchaka reviewed Jul 19, 2023

View reviewed changes

erlend-aasland added 2 commits July 19, 2023 12:43

Pull in main

cd940e2

erlend-aasland added 8 commits July 19, 2023 22:38

Pull in main

d1627ae

Use :data: for METH_O and METH_NOARGS

8f23956

For now, disable the METH_METHOD link

b155e38

Suggest 'make clinic' and 'make regen-global-objects' iso. running cl…

971c058

…inic directly

Markup file suffixes and file paths with :file:

bc33f97

Address review: rewrite line 919 similar to suggestion by Serhiy

f5bb4a3

fixup! Suggest 'make clinic' and 'make regen-global-objects' iso. run…

f892322

…ning clinic directly

Address review: markup more params with **

d96fdeb

erlend-aasland requested review from serhiy-storchaka and ezio-melotti July 19, 2023 21:31

erlend-aasland added 2 commits July 20, 2023 10:36

Pull in main

f593853

Address review: revert :program: markups

47061df

erlend-aasland mentioned this pull request Jul 20, 2023

gh-106799: Pick another example method for Argument Clinic How-To #106800

Closed

AA-Turner approved these changes Jul 24, 2023

View reviewed changes

serhiy-storchaka approved these changes Jul 24, 2023

View reviewed changes

Doc/howto/clinic.rst Outdated Show resolved Hide resolved

erlend-aasland added 2 commits July 24, 2023 17:05

Pull in main

eaaeb42

METH_METHOD now has its own anchor

8454b78

erlend-aasland enabled auto-merge (squash) July 24, 2023 15:10

erlend-aasland disabled auto-merge July 24, 2023 15:11

erlend-aasland enabled auto-merge (squash) July 24, 2023 15:11

erlend-aasland disabled auto-merge July 24, 2023 15:11

erlend-aasland enabled auto-merge (squash) July 24, 2023 15:12

erlend-aasland merged commit ff5f94b into python:main Jul 24, 2023
20 checks passed

bedevere-bot removed the awaiting merge label Jul 24, 2023

miss-islington assigned erlend-aasland Jul 24, 2023

bedevere-bot removed the needs backport to 3.12 bug and security fixes label Jul 24, 2023

erlend-aasland deleted the clinic-docs/missing-markup branch July 24, 2023 15:27

bedevere-bot removed the needs backport to 3.11 only security fixes label Jul 24, 2023

jtcave pushed a commit to jtcave/cpython that referenced this pull request Jul 27, 2023

Docs: Add missing markup to Argument Clinic docs (python#106876)

b629231

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>

erlend-aasland added a commit to erlend-aasland/devguide that referenced this pull request Sep 8, 2023

Docs: Add missing markup to Argument Clinic docs (python/cpython#106876)

c2b6e99

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>

AA-Turner pushed a commit to AA-Turner/devguide that referenced this pull request Sep 13, 2023

Docs: Add missing markup to Argument Clinic docs (python/cpython#106876)

4eda298

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>

erlend-aasland added a commit to python/devguide that referenced this pull request Sep 26, 2023

Docs: Add missing markup to Argument Clinic docs (python/cpython#106876)

1bb1c45

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs: Add missing markup to Argument Clinic docs #106876

Docs: Add missing markup to Argument Clinic docs #106876

erlend-aasland commented Jul 18, 2023 •

edited by github-actions bot

erlend-aasland commented Jul 18, 2023

serhiy-storchaka left a comment

erlend-aasland commented Jul 19, 2023

erlend-aasland commented Jul 19, 2023

erlend-aasland commented Jul 20, 2023

erlend-aasland commented Jul 22, 2023

erlend-aasland commented Jul 24, 2023

miss-islington commented Jul 24, 2023

miss-islington commented Jul 24, 2023

bedevere-bot commented Jul 24, 2023

bedevere-bot commented Jul 24, 2023

Docs: Add missing markup to Argument Clinic docs #106876

Docs: Add missing markup to Argument Clinic docs #106876

Conversation

erlend-aasland commented Jul 18, 2023 • edited by github-actions bot

erlend-aasland commented Jul 18, 2023

serhiy-storchaka left a comment

Choose a reason for hiding this comment

erlend-aasland commented Jul 19, 2023

erlend-aasland commented Jul 19, 2023

erlend-aasland commented Jul 20, 2023

erlend-aasland commented Jul 22, 2023

erlend-aasland commented Jul 24, 2023

miss-islington commented Jul 24, 2023

miss-islington commented Jul 24, 2023

bedevere-bot commented Jul 24, 2023

bedevere-bot commented Jul 24, 2023

erlend-aasland commented Jul 18, 2023 •

edited by github-actions bot