← 返回首页
gh-93738: Documentation C syntax (Function glob patterns -> literal markup) by AA-Turner · Pull Request #97774 · python/cpython · GitHub
Skip to content

Navigation Menu

Toggle navigation
Sign in
Appearance settings
Search or jump to...

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

Provide feedback

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

Include my email address so I can be contacted
Cancel Submit feedback

Saved searches

Use saved searches to filter your results more quickly

Cancel Create saved search
Appearance settings
Resetting focus

gh-93738: Documentation C syntax (Function glob patterns -> literal markup)#97774

Merged
ambv merged 4 commits into
python:mainfrom
AA-Turner:sphinx-3-func-glob
Oct 5, 2022
Merged

gh-93738: Documentation C syntax (Function glob patterns -> literal markup)#97774
ambv merged 4 commits into
python:mainfrom
AA-Turner:sphinx-3-func-glob

Conversation

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

Copy link
Copy Markdown
Member

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

A

bedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Oct 3, 2022
AA-Turner self-assigned this Oct 3, 2022
AA-Turner mentioned this pull request Oct 3, 2022
Closed
AA-Turner added needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes labels Oct 3, 2022
ezio-melotti reviewed Oct 4, 2022
View reviewed changes

ezio-melotti left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

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

ambv commented Oct 4, 2022

Copy link
Copy Markdown
Contributor

We have some conflicts here now.

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

AA-Turner commented Oct 5, 2022

Copy link
Copy Markdown
Member Author

Conflicts resolved.

A

ambv merged commit 0e72606 into python:main Oct 5, 2022

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 5, 2022
pythongh-93738: Documentation C syntax (Function glob patterns -> lit… …
cadaf6b
…eral markup) (pythonGH-97774) (cherry picked from commit 0e72606) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 5, 2022
pythongh-93738: Documentation C syntax (Function glob patterns -> lit… …
bd0acd9
…eral markup) (pythonGH-97774) (cherry picked from commit 0e72606) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
bedevere-bot removed the needs backport to 3.11 only security fixes label Oct 5, 2022

bedevere-bot commented Oct 5, 2022

Copy link
Copy Markdown

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

bedevere-bot commented Oct 5, 2022

Copy link
Copy Markdown

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

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
[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 <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Łukasz Langa <lukasz@langa.pl>
ambv added a commit that referenced this pull request Oct 5, 2022
[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 <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Łukasz Langa <lukasz@langa.pl>
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
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
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
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
[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 <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Łukasz Langa <lukasz@langa.pl>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

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

Assignees

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.

6 participants

Footer

© 2026 GitHub, Inc.