Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Docs: Add missing markup to Argument Clinic docs#106876

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.

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

Already on GitHub?Sign in to your account

Merged

Conversation

erlend-aasland
Copy link
Contributor

@erlend-aaslanderlend-aasland commentedJul 18, 2023•
edited by github-actionsbot
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/

- Add :py:func:, :c:func:, etc. where appropriate- Remove repeated links within the same paragraph
@erlend-aasland
Copy link
ContributorAuthor

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.

Copy link
Member

@serhiy-storchakaserhiy-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 functionPyArg_Parse(), and there is a family of functionsPyArg_Parse*(). This document may use the former in the meaning of the latter.

erlend-aasland and ezio-melotti reacted with thumbs up emoji
@erlend-aasland
Copy link
ContributorAuthor

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

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

@serhiy-storchaka and@ezio-melotti: I've addressed some remarks in6e5c44f

@erlend-aasland
Copy link
ContributorAuthor

With47061df, I think I've addressed all your remarks,@ezio-melotti.

@erlend-aasland
Copy link
ContributorAuthor

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

@erlend-aasland
Copy link
ContributorAuthor

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

@erlend-aaslanderlend-aaslandenabled auto-merge (squash)July 24, 2023 15:10
@erlend-aaslanderlend-aaslandenabled auto-merge (squash)July 24, 2023 15:11
@erlend-aaslanderlend-aaslandenabled auto-merge (squash)July 24, 2023 15:12
@erlend-aaslanderlend-aasland merged commitff5f94b intopython:mainJul 24, 2023
@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 to3.11 due to a conflict.
Please backport usingcherry_picker on command line.
cherry_picker ff5f94b72c8aad8e45c397c263dbe7f19221735f 3.11

@bedevere-bot
Copy link

GH-107181 is a backport of this pull request to the3.12 branch.

@bedevere-botbedevere-bot removed the needs backport to 3.12only security fixes labelJul 24, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull requestJul 24, 2023
(cherry picked from commitff5f94b)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>
@erlend-aaslanderlend-aasland deleted the clinic-docs/missing-markup branchJuly 24, 2023 15:27
erlend-aasland added a commit that referenced this pull requestJul 24, 2023
…107181)(cherry picked from commitff5f94b)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
Copy link

GH-107182 is a backport of this pull request to the3.11 branch.

@bedevere-botbedevere-bot removed the needs backport to 3.11only security fixes labelJul 24, 2023
erlend-aasland added a commit to erlend-aasland/cpython that referenced this pull requestJul 24, 2023
(cherry picked from commitff5f94b)Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
erlend-aasland added a commit that referenced this pull requestJul 24, 2023
…07182)(cherry picked from commitff5f94b)Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
carljm added a commit to carljm/cpython that referenced this pull requestJul 24, 2023
* 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 requestJul 27, 2023
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 requestSep 8, 2023
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 requestSep 13, 2023
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 requestSep 26, 2023
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@serhiy-storchakaserhiy-storchakaserhiy-storchaka approved these changes

@AA-TurnerAA-TurnerAA-Turner approved these changes

@ezio-melottiezio-melottiezio-melotti approved these changes

Assignees

@erlend-aaslanderlend-aasland

Labels
docsDocumentation in the Doc dirskip issueskip 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
[8]ページ先頭
©2009-2025 Movatter.jp