Skip to content

Typo in Macro/C/Python Type Table #112671

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
Closed
ecsalina opened this issue Dec 3, 2023 · 1 comment · Fixed by #112715
Closed

Typo in Macro/C/Python Type Table #112671

ecsalina opened this issue Dec 3, 2023 · 1 comment · Fixed by #112715
Labels
docs Documentation in the Doc dir easy

Comments

@ecsalina
Copy link

ecsalina commented Dec 3, 2023 •
edited by bedevere-app bot
Loading

The (*) footnote to the table in this section of the documentation has a typo. It says:

with Py_T_STRING_INLINE the string is stored directly in the structure

but it seems like it should be:

with Py_T_STRING_INPLACE the string is stored directly in the structure

based on what the (*) is referencing in the table. A quick search of the CPython repo shows no results for Py_T_STRING_INLINE (except for this documentation) and many results for Py_T_STRING_INPLACE. This bug would be resolved by substituting Py_T_STRING_INLINE with Py_T_STRING_INPLACE.

Linked PRs
@ecsalina ecsalina added the docs Documentation in the Doc dir label Dec 3, 2023
@serhiy-storchaka
Copy link
Member

Thank you for your report @ecsalina. Do you mind to create a PR?

@Amioplk Amioplk mentioned this issue Dec 4, 2023
Merged
serhiy-storchaka pushed a commit that referenced this issue Dec 4, 2023
@Amioplk
gh-112671: Fixing typo in the Macro Docs (GH-112715)
a8ce149 
Replace Py_T_STRING_INLINE with Py_T_STRING_INPLACE
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Dec 4, 2023
@Amioplk @miss-islington
pythongh-112671: Fixing typo in the Macro Docs (pythonGH-112715)
69a4dd0 
Replace Py_T_STRING_INLINE with Py_T_STRING_INPLACE
(cherry picked from commit a8ce149)

Co-authored-by: Amioplk <[email protected]>
@bedevere-app bedevere-app bot mentioned this issue Dec 4, 2023
Merged
serhiy-storchaka pushed a commit that referenced this issue Dec 4, 2023
@miss-islington @Amioplk
[3.12] gh-112671: Fixing typo in the Macro Docs (GH-112715) (GH-112726)
494cd50 
Replace Py_T_STRING_INLINE with Py_T_STRING_INPLACE
(cherry picked from commit a8ce149)

Co-authored-by: Amioplk <[email protected]>
aisk pushed a commit to aisk/cpython that referenced this issue Feb 11, 2024
@Amioplk @aisk
pythongh-112671: Fixing typo in the Macro Docs (pythonGH-112715)
b5c5665 
Replace Py_T_STRING_INLINE with Py_T_STRING_INPLACE
Glyphack pushed a commit to Glyphack/cpython that referenced this issue Sep 2, 2024
@Amioplk @Glyphack
pythongh-112671: Fixing typo in the Macro Docs (pythonGH-112715)
6656b7b 
Replace Py_T_STRING_INLINE with Py_T_STRING_INPLACE
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation in the Doc dir easy
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

gh-112671: Fixing typo in the Macro Docs Amioplk/cpython
2 participants
@serhiy-storchaka @ecsalina