Skip to content

fix variable name in dis documentation #109343

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 13, 2023
Merged

Conversation

olekskrav
Copy link
Contributor

@olekskrav olekskrav commented Sep 12, 2023

BINARY_SUBSCR opcode explanation erroneously uses two different names key and index to refer to the same variable. STORE_SUBSCR and DELETE_SUBSCR use only key in the same context. Changing index to key for consistency.


📚 Documentation preview 📚: https://cpython-previews--109343.org.readthedocs.build/

BINARY_SUBSCR example erroneously uses two different names `key` and `index` to refer to the same variable. STORE_SUBSCR and DELETE_SUBSCR use only `key` in the same context. Changing `index` to `key` for consistency.
@ghost
Copy link

ghost commented Sep 12, 2023

All commit authors signed the Contributor License Agreement.
CLA signed

@bedevere-app bedevere-app bot added awaiting review docs Documentation in the Doc dir skip news labels Sep 12, 2023
@miss-islington
Copy link
Contributor

Thanks @olekskrav for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 13, 2023
BINARY_SUBSCR example erroneously uses two different names `key` and `index` to refer to the same variable. STORE_SUBSCR and DELETE_SUBSCR use only `key` in the same context. Changing `index` to `key` for consistency.
(cherry picked from commit a0c06a4)

Co-authored-by: Oleksandr Kravets <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Sep 13, 2023

GH-109364 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 only security fixes label Sep 13, 2023
@serhiy-storchaka
Copy link
Member

Thank you for your contribution @olekskrav.

Yhg1s pushed a commit that referenced this pull request Sep 13, 2023
…09364)

Fix variable name in dis documentation example (GH-109343)

BINARY_SUBSCR example erroneously uses two different names `key` and `index` to refer to the same variable. STORE_SUBSCR and DELETE_SUBSCR use only `key` in the same context. Changing `index` to `key` for consistency.
(cherry picked from commit a0c06a4)

Co-authored-by: Oleksandr Kravets <[email protected]>
vstinner pushed a commit to vstinner/cpython that referenced this pull request Sep 13, 2023
BINARY_SUBSCR example erroneously uses two different names `key` and `index` to refer to the same variable. STORE_SUBSCR and DELETE_SUBSCR use only `key` in the same context. Changing `index` to `key` for consistency.
@olekskrav
Copy link
Contributor Author

Thank you all for the quick work on this pull request!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants