Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs: Add missing markup to Argument Clinic docs #106876

Merged
merged 22 commits into from
Jul 24, 2023
Merged

Docs: Add missing markup to Argument Clinic docs #106876

merged 22 commits into from
Jul 24, 2023

Conversation

erlend-aasland
Copy link
Contributor

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

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

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

@erlend-aasland
Docs: Add missing markup to Argument Clinic docs
e8068e0 
- Add :py:func:, :c:func:, etc. where appropriate
- Remove repeated links within the same paragraph
@bedevere-bot bedevere-bot added awaiting core review docs Documentation in the Doc dir labels Jul 18, 2023
@erlend-aasland
Copy link
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.

ezio-melotti
ezio-melotti reviewed Jul 19, 2023
View reviewed changes
Doc/howto/clinic.rst Outdated Show resolved Hide resolved
Doc/howto/clinic.rst Outdated Show resolved Hide resolved
Doc/howto/clinic.rst Outdated Show resolved Hide resolved
Doc/howto/clinic.rst Outdated Show resolved Hide resolved
Doc/howto/clinic.rst Outdated Show resolved Hide resolved
Doc/howto/clinic.rst Outdated Show resolved Hide resolved
Doc/howto/clinic.rst Outdated Show resolved Hide resolved
Doc/howto/clinic.rst Outdated Show resolved Hide resolved
Doc/howto/clinic.rst Outdated Show resolved Hide resolved
Doc/howto/clinic.rst Outdated Show resolved Hide resolved
serhiy-storchaka
serhiy-storchaka reviewed Jul 19, 2023
View reviewed changes
Copy link
Member

@serhiy-storchaka serhiy-storchaka left a 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.

Doc/howto/clinic.rst Show resolved Hide resolved
Doc/howto/clinic.rst Outdated Show resolved Hide resolved
Doc/howto/clinic.rst Outdated Show resolved Hide resolved
Doc/howto/clinic.rst Outdated Show resolved Hide resolved
Doc/howto/clinic.rst Outdated Show resolved Hide resolved
Doc/howto/clinic.rst Outdated Show resolved Hide resolved
Doc/howto/clinic.rst Show resolved Hide resolved
Doc/howto/clinic.rst Outdated Show resolved Hide resolved
Doc/howto/clinic.rst Outdated Show resolved Hide resolved
Doc/howto/clinic.rst Outdated Show resolved Hide resolved
@erlend-aasland
Copy link
Contributor Author

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

@erlend-aasland
Pull in main
cd940e2
@erlend-aasland
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
Copy link
Contributor Author

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

@erlend-aasland
Copy link
Contributor Author

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

@erlend-aasland erlend-aasland mentioned this pull request Jul 20, 2023
Closed
@erlend-aasland
Copy link
Contributor Author

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

@erlend-aasland
Copy link
Contributor Author

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

serhiy-storchaka
serhiy-storchaka approved these changes Jul 24, 2023
View reviewed changes
Doc/howto/clinic.rst Outdated Show resolved Hide resolved
@erlend-aasland erlend-aasland enabled auto-merge (squash) July 24, 2023 15:10
@erlend-aasland erlend-aasland enabled auto-merge (squash) July 24, 2023 15:11
@erlend-aasland erlend-aasland enabled auto-merge (squash) July 24, 2023 15:12
@erlend-aasland erlend-aasland merged commit ff5f94b into python:main Jul 24, 2023
15 checks passed
@miss-islington
Copy link
Contributor

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

@miss-islington
Copy link
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

@bedevere-bot
Copy link

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

@bedevere-bot bedevere-bot removed the needs backport to 3.12 bug and security fixes label Jul 24, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 24, 2023
@erlend-aasland @ezio-melotti
@serhiy-storchaka @miss-islington
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 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
@miss-islington @erlend-aasland
@ezio-melotti @serhiy-storchaka
[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
Copy link

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

@bedevere-bot 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
@erlend-aasland @ezio-melotti @serhiy-storchaka
[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
@erlend-aasland @ezio-melotti @serhiy-storchaka
[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
@carljm
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
@erlend-aasland @ezio-melotti
@serhiy-storchaka @jtcave
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
@erlend-aasland @ezio-melotti @serhiy-storchaka
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
@erlend-aasland @ezio-melotti @serhiy-storchaka
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
@erlend-aasland @ezio-melotti @serhiy-storchaka
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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ezio-melotti ezio-melotti ezio-melotti approved these changes

@AA-Turner AA-Turner AA-Turner approved these changes

@serhiy-storchaka serhiy-storchaka serhiy-storchaka approved these changes

Assignees

@erlend-aasland 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.
6 participants
@erlend-aasland @miss-islington @bedevere-bot @serhiy-storchaka @AA-Turner @ezio-melotti