Skip to content

gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) #97768

New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom
Merged
merged 4 commits into from
Oct 5, 2022
Merged

gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) #97768

merged 4 commits into from
Oct 5, 2022

Conversation

AA-Turner
Copy link
Member

@AA-Turner AA-Turner commented Oct 3, 2022 •
edited by bedevere-bot
Loading

Part of #93738. This PR converts references for native C types to the c:expr syntax.

A

@AA-Turner AA-Turner requested a review from tiran as a code owner October 3, 2022 16:41
@bedevere-bot bedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Oct 3, 2022
@AA-Turner AA-Turner self-assigned this Oct 3, 2022
@AA-Turner AA-Turner mentioned this pull request Oct 3, 2022
Closed
@AA-Turner AA-Turner added needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes labels Oct 3, 2022
@ambv
Copy link
Contributor

ambv commented Oct 4, 2022

We have some conflicts here now.

@AA-Turner
Merge branch 'main' into sphinx-3-c-types
889e46e 
# Conflicts:
#	Doc/c-api/dict.rst
#	Doc/c-api/init.rst
#	Doc/c-api/marshal.rst
@AA-Turner
Copy link
Member Author

Resolved.

A

@ambv ambv merged commit 0031e62 into python:main Oct 5, 2022
@miss-islington
Copy link
Contributor

Thanks @AA-Turner for the PR, and @ambv for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.11.
🐍🍒⛏🤖

@miss-islington
Copy link
Contributor

Sorry, @AA-Turner and @ambv, I could not cleanly backport this to 3.11 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 0031e62973801d34a9e19ab7bb199e9668e32d7b 3.11

@miss-islington miss-islington assigned ambv and unassigned AA-Turner Oct 5, 2022
@miss-islington
Copy link
Contributor

Sorry @AA-Turner and @ambv, I had trouble checking out the 3.10 backport branch.
Please backport using cherry_picker on command line.
cherry_picker 0031e62973801d34a9e19ab7bb199e9668e32d7b 3.10

ambv pushed a commit to ambv/cpython that referenced this pull request Oct 5, 2022
@AA-Turner @ambv
[3.11] pythongh-93738: Documentation C syntax (:c:type:<C type> -> :c…
5e39a69 
…:expr:<C type>) (pythonGH-97768)

:c:type:`<C type>` -> :c:expr:`<C type>`

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 0031e62)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@bedevere-bot
Copy link

GH-97924 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 Oct 5, 2022
ambv pushed a commit to ambv/cpython that referenced this pull request Oct 5, 2022
@AA-Turner @ambv
[3.10] pythongh-93738: Documentation C syntax (:c:type:<C type> -> :c…
5719d7a 
…:expr:<C type>) (pythonGH-97768)

:c:type:`<C type>` -> :c:expr:`<C type>`

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 0031e62)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@bedevere-bot
Copy link

GH-97925 is a backport of this pull request to the 3.10 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.10 only security fixes label Oct 5, 2022
ambv added a commit that referenced this pull request Oct 5, 2022
@ambv @AA-Turner
[3.10] gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:…
3b0f2a7 
…<C type>) (GH-97768) (#97925)

:c:type:`<C type>` -> :c:expr:`<C type>`

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 0031e62)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
ambv added a commit that referenced this pull request Oct 5, 2022
@ambv @AA-Turner
[3.11] gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:…
83ad762 
…<C type>) (GH-97768) (#97924)

:c:type:`<C type>` -> :c:expr:`<C type>`

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 0031e62)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@AA-Turner AA-Turner deleted the sphinx-3-c-types branch October 6, 2022 17:20
carljm added a commit to carljm/cpython that referenced this pull request Oct 6, 2022
@carljm
Merge branch 'main' into dictwatch
4bb5d9d 
* main: (66 commits)
  pythongh-65961: Raise `DeprecationWarning` when `__package__` differs from `__spec__.parent` (python#97879)
  docs(typing): add "see PEP 675" to LiteralString (python#97926)
  pythongh-97850: Remove all known instances of module_repr() (python#97876)
  I changed my surname early this year (python#96671)
  pythongh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) (python#97768)
  pythongh-91539: improve performance of get_proxies_environment  (python#91566)
  build(deps): bump actions/stale from 5 to 6 (python#97701)
  pythonGH-95172 Make the same version `versionadded` oneline (python#95172)
  pythongh-88050: Fix asyncio subprocess to kill process cleanly when process is blocked (python#32073)
  pythongh-93738: Documentation C syntax (Function glob patterns -> literal markup) (python#97774)
  pythongh-93357: Port test cases to IsolatedAsyncioTestCase, part 2 (python#97896)
  pythongh-95196: Disable incorrect pickling of the C implemented classmethod descriptors (pythonGH-96383)
  pythongh-97758: Fix a crash in getpath_joinpath() called without arguments (pythonGH-97759)
  pythongh-74696: Pass root_dir to custom archivers which support it (pythonGH-94251)
  pythongh-97661: Improve accuracy of sqlite3.Cursor.fetchone docs (python#97662)
  pythongh-87092: bring compiler code closer to a preprocessing-opt-assembler organisation (pythonGH-97644)
  pythonGH-96704: Add {Task,Handle}.get_context(), use it in call_exception_handler() (python#96756)
  pythongh-93738: Documentation C syntax (:c:type:`PyTypeObject*` -> :c:expr:`PyTypeObject*`) (python#97778)
  pythongh-97825: fix AttributeError when calling subprocess.check_output(input=None) with encoding or errors args (python#97826)
  Add re.VERBOSE flag documentation example (python#97678)
  ...
carljm added a commit to carljm/cpython that referenced this pull request Oct 8, 2022
@carljm
Merge branch 'main' into typewatch
1af2a98 
* main: (53 commits)
  pythongh-94808: Coverage: Test that maximum indentation level is handled (python#95926)
  pythonGH-88050: fix race in closing subprocess pipe in asyncio  (python#97951)
  pythongh-93738: Disallow pre-v3 syntax in the C domain (python#97962)
  pythongh-95986: Fix the example using match keyword (python#95989)
  pythongh-97897: Prevent os.mkfifo and os.mknod segfaults with macOS 13 SDK (pythonGH-97944)
  pythongh-94808: Cover `PyUnicode_Count` in CAPI (python#96929)
  pythongh-94808: Cover `PyObject_PyBytes` case with custom `__bytes__` method (python#96610)
  pythongh-95691: Doc BufferedWriter and BufferedReader (python#95703)
  pythonGH-88968: Add notes about socket ownership transfers (python#97936)
  pythongh-96865: [Enum] fix Flag to use CONFORM boundary (pythonGH-97528)
  pythongh-65961: Raise `DeprecationWarning` when `__package__` differs from `__spec__.parent` (python#97879)
  docs(typing): add "see PEP 675" to LiteralString (python#97926)
  pythongh-97850: Remove all known instances of module_repr() (python#97876)
  I changed my surname early this year (python#96671)
  pythongh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) (python#97768)
  pythongh-91539: improve performance of get_proxies_environment  (python#91566)
  build(deps): bump actions/stale from 5 to 6 (python#97701)
  pythonGH-95172 Make the same version `versionadded` oneline (python#95172)
  pythongh-88050: Fix asyncio subprocess to kill process cleanly when process is blocked (python#32073)
  pythongh-93738: Documentation C syntax (Function glob patterns -> literal markup) (python#97774)
  ...
mpage pushed a commit to mpage/cpython that referenced this pull request Oct 11, 2022
@AA-Turner @ambv @mpage
pythongh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<…
5da6c6b 
…C type>) (python#97768)

:c:type:`<C type>` -> :c:expr:`<C type>`

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
pablogsal pushed a commit that referenced this pull request Oct 22, 2022
@ambv @AA-Turner @pablogsal
[3.11] gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:…
e48d6df 
…<C type>) (GH-97768) (#97924)

:c:type:`<C type>` -> :c:expr:`<C type>`

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 0031e62)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

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

@tiran tiran Awaiting requested review from tiran

Assignees

@ambv ambv

Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@AA-Turner @ambv @miss-islington @bedevere-bot @ezio-melotti