GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing github.com — Docs: Add missing markup to Argument Clinic docs by erlend-aasland · Pull Request #106876 · python/cpython

Conversation

erlend-aasland commented Jul 18, 2023 •

edited by github-actions Bot

Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link

Copy Markdown

Contributor

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

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions


          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 only 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

erlend-aasland commented Jul 18, 2023

Copy link

Copy Markdown

Contributor Author

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.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.


          Add missing colon

cf66105

ezio-melotti reviewed

Jul 19, 2023

View reviewed changes

Comment thread

Doc/howto/clinic.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

Doc/howto/clinic.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

Doc/howto/clinic.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

Doc/howto/clinic.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

Doc/howto/clinic.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

Doc/howto/clinic.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

Doc/howto/clinic.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

Doc/howto/clinic.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

Doc/howto/clinic.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

Doc/howto/clinic.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

serhiy-storchaka reviewed

Jul 19, 2023

View reviewed changes

serhiy-storchaka left a comment

Copy link

Copy Markdown

Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

erlend-aasland and ezio-melotti reacted with thumbs up emoji

All reactions

👍 2 reactions

Comment thread

Doc/howto/clinic.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

Doc/howto/clinic.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

Doc/howto/clinic.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

Doc/howto/clinic.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

Doc/howto/clinic.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

Doc/howto/clinic.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

Doc/howto/clinic.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

Doc/howto/clinic.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

Doc/howto/clinic.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

Doc/howto/clinic.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

erlend-aasland commented Jul 19, 2023

Copy link

Copy Markdown

Contributor Author

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

ezio-melotti reacted with rocket emoji

All reactions

🚀 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

erlend-aasland added 2 commits

July 19, 2023 12:43


          Pull in main

cd940e2


          Address reviews

6e5c44f

- 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 commented Jul 19, 2023

Copy link

Copy Markdown

Contributor Author

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

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 ezio-melotti and serhiy-storchaka

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 commented Jul 20, 2023

Copy link

Copy Markdown

Contributor Author

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

erlend-aasland mentioned this pull request

Jul 20, 2023

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

Closed

erlend-aasland commented Jul 22, 2023

Copy link

Copy Markdown

Contributor Author

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

erlend-aasland commented Jul 24, 2023

Copy link

Copy Markdown

Contributor Author

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

AA-Turner reacted with hooray emoji

All reactions

🎉 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

AA-Turner approved these changes

Jul 24, 2023

View reviewed changes

serhiy-storchaka approved these changes

Jul 24, 2023

View reviewed changes

Comment thread

Doc/howto/clinic.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

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

bedevere-bot removed the awaiting merge label

Jul 24, 2023

miss-islington commented Jul 24, 2023

Copy link

Copy Markdown

Contributor

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

miss-islington commented Jul 24, 2023

Copy link

Copy Markdown

Contributor

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

bedevere-bot commented Jul 24, 2023

Copy link

Copy Markdown

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

miss-islington assigned erlend-aasland

Jul 24, 2023

bedevere-bot removed the needs backport to 3.12 only security fixes label

Jul 24, 2023

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request

Jul 24, 2023


          Docs: Add missing markup to Argument Clinic docs (pythonGH-106876)

c4cd631

(cherry picked from commit ff5f94b)

Co-authored-by: Erlend E. Aasland <[email protected]>
Co-authored-by: Ezio Melotti <[email protected]>
Co-authored-by: Serhiy Storchaka <[email protected]>

erlend-aasland deleted the clinic-docs/missing-markup branch

July 24, 2023 15:27

erlend-aasland added a commit that referenced this pull request

Jul 24, 2023


          [3.12] Docs: Add missing markup to Argument Clinic docs (GH-106876) (#…

5ff4dfa

…107181)

(cherry picked from commit ff5f94b)

Co-authored-by: Erlend E. Aasland <[email protected]>
Co-authored-by: Ezio Melotti <[email protected]>
Co-authored-by: Serhiy Storchaka <[email protected]>

bedevere-bot commented Jul 24, 2023

Copy link

Copy Markdown

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

bedevere-bot removed the needs backport to 3.11 only security fixes label

Jul 24, 2023

erlend-aasland added a commit to erlend-aasland/cpython that referenced this pull request

Jul 24, 2023


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

1e82806

(cherry picked from commit ff5f94b)

Co-authored-by: Ezio Melotti <[email protected]>
Co-authored-by: Serhiy Storchaka <[email protected]>

erlend-aasland added a commit that referenced this pull request

Jul 24, 2023


          [3.11] Docs: Add missing markup to Argument Clinic docs (#106876) (#1…

604eb04

…07182)

(cherry picked from commit ff5f94b)

Co-authored-by: Ezio Melotti <[email protected]>
Co-authored-by: Serhiy Storchaka <[email protected]>

carljm added a commit to carljm/cpython that referenced this pull request

Jul 24, 2023


          Merge branch 'main' into superfix

9a6bdfa

* 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)
  ...

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 <[email protected]>
Co-authored-by: Serhiy Storchaka <[email protected]>

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 <[email protected]>
Co-authored-by: Serhiy Storchaka <[email protected]>

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 <[email protected]>
Co-authored-by: Serhiy Storchaka <[email protected]>

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 <[email protected]>
Co-authored-by: Serhiy Storchaka <[email protected]>

Reviewers

serhiy-storchaka

serhiy-storchaka approved these changes

AA-Turner

AA-Turner approved these changes

ezio-melotti

ezio-melotti approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

erlend-aasland

Labels

docs

Documentation in the Doc dir

skip issue skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

6 participants

Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.

GeezerVison

Conversation

erlend-aasland commented Jul 18, 2023 • edited by github-actions Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

erlend-aasland commented Jul 18, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

serhiy-storchaka left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

erlend-aasland commented Jul 19, 2023

Uh oh!

erlend-aasland commented Jul 19, 2023

Uh oh!

erlend-aasland commented Jul 20, 2023

Uh oh!

erlend-aasland commented Jul 22, 2023

Uh oh!

erlend-aasland commented Jul 24, 2023

Uh oh!

Uh oh!

miss-islington commented Jul 24, 2023

Uh oh!

miss-islington commented Jul 24, 2023

Uh oh!

bedevere-bot commented Jul 24, 2023

Uh oh!

bedevere-bot commented Jul 24, 2023

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

erlend-aasland commented Jul 18, 2023 •

edited by github-actions Bot

Loading

Uh oh!

There was an error while loading. Please reload this page.