GV

GeezerVison

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

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — gh-93738: Documentation C syntax (Function glob patterns -> literal markup) by AA-Turner · Pull Request #97774 · python/cpython

Conversation

@AA-Turner

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

Uh oh!

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

Copy link
Copy Markdown
Member

Part of #93738. This PR converts references for multiple functions with * to literal markup syntax.

A

  • Issue: Update C domain docs to Sphinx 3 syntax #93738

Sorry, something went wrong.

Uh oh!

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

All reactions
@AA-Turner
Function glob patterns -> literal markup
7ea40fe
@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
Function glob patterns -> literal markup (PyArg_Parse)
d853b8f
@AA-Turner AA-Turner mentioned this pull request Oct 3, 2022
Update C domain docs to Sphinx 3 syntax #93738
Closed
@AA-Turner AA-Turner added needs backport to 3.10 needs backport to 3.11 only security fixes labels Oct 3, 2022
ezio-melotti
ezio-melotti reviewed Oct 4, 2022
View reviewed changes

@ezio-melotti ezio-melotti 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.

Why can't these be converted to :c:expr: instead?

Sorry, something went wrong.

Uh oh!

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

ambv reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
@ambv

ambv commented Oct 4, 2022

Copy link
Copy Markdown
Contributor

We have some conflicts here now.

All reactions

Sorry, something went wrong.

Uh oh!

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

@AA-Turner

AA-Turner commented Oct 5, 2022

Copy link
Copy Markdown
Member Author

Why can't these be converted to :c:expr: instead?

For where the stem is a valid macro or function, it could, but I think that goes against the spirit where c:expr is to be used for acual expressions. If we want to link to the stem object, I think we should do so explicitly a la :c:func:`STEM_* <STEM>`. But that could be a later change, this is only making the markup valid for Sphinx 3 and beyond.

A

ezio-melotti reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

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

AA-Turner added 2 commits October 5, 2022 12:41
@AA-Turner
Drop unneeded backslashes
9b828dd
@AA-Turner
Merge branch 'main' into sphinx-3-func-glob
1afcdb7
# Conflicts:
#	Doc/c-api/typeobj.rst
@AA-Turner

AA-Turner commented Oct 5, 2022

Copy link
Copy Markdown
Member Author

Conflicts resolved.

A

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.

ezio-melotti
ezio-melotti approved these changes Oct 5, 2022
View reviewed changes
@bedevere-bot bedevere-bot added awaiting merge and removed awaiting review labels Oct 5, 2022
orsenthil
orsenthil approved these changes Oct 5, 2022
View reviewed changes
@ambv
ambv merged commit 0e72606 into python:main Oct 5, 2022
@miss-islington

miss-islington commented Oct 5, 2022

Copy link
Copy Markdown
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.
🐍🍒⛏🤖

All reactions

Sorry, something went wrong.

Uh oh!

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

@bedevere-bot bedevere-bot removed the awaiting merge label Oct 5, 2022
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 5, 2022
@AA-Turner @miss-islington
pythongh-93738: Documentation C syntax (Function glob patterns -> lit…
cadaf6b
…eral markup) (pythonGH-97774)

(cherry picked from commit 0e72606)

Co-authored-by: Adam Turner <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 5, 2022
@AA-Turner @miss-islington
pythongh-93738: Documentation C syntax (Function glob patterns -> lit…
bd0acd9
…eral markup) (pythonGH-97774)

(cherry picked from commit 0e72606)

Co-authored-by: Adam Turner <[email protected]>
@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Oct 5, 2022
@bedevere-bot

bedevere-bot commented Oct 5, 2022

Copy link
Copy Markdown

GH-97910 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

bedevere-bot commented Oct 5, 2022

Copy link
Copy Markdown

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

All reactions

Sorry, something went wrong.

Uh oh!

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

@bedevere-bot bedevere-bot removed the needs backport to 3.10 label Oct 5, 2022
ambv added a commit that referenced this pull request Oct 5, 2022
@miss-islington @AA-Turner @ambv
[3.11] gh-93738: Documentation C syntax (Function glob patterns -> li…
92054df
…teral markup) (GH-97774) (#97910)

(cherry picked from commit 0e72606)

Co-authored-by: Adam Turner <[email protected]>
Co-authored-by: Łukasz Langa <[email protected]>
ambv added a commit that referenced this pull request Oct 5, 2022
@miss-islington @AA-Turner @ambv
[3.10] gh-93738: Documentation C syntax (Function glob patterns -> li…
b39182e
…teral markup) (GH-97774) (#97911)

(cherry picked from commit 0e72606)

Co-authored-by: Adam Turner <[email protected]>
Co-authored-by: Łukasz Langa <[email protected]>
@AA-Turner
AA-Turner deleted the sphinx-3-func-glob 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 @mpage
pythongh-93738: Documentation C syntax (Function glob patterns -> lit…
d1e99a7
…eral markup) (python#97774)
pablogsal pushed a commit that referenced this pull request Oct 22, 2022
@miss-islington @AA-Turner
@ambv @pablogsal
[3.11] gh-93738: Documentation C syntax (Function glob patterns -> li…
6ff98f7
…teral markup) (GH-97774) (#97910)

(cherry picked from commit 0e72606)

Co-authored-by: Adam Turner <[email protected]>
Co-authored-by: Łukasz Langa <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

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

Uh oh!

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

Assignees

@AA-Turner AA-Turner

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.

Uh oh!

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

6 participants

@AA-Turner @ambv @miss-islington @bedevere-bot @orsenthil @ezio-melotti
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.