Skip to content

Fix inconsistencies in InternalDocs/parser.md - #154917

Merged
ZeroIntensity merged 2 commits into
python:mainfrom
YangSiJun528:fix-parser-typo
Jul 31, 2026
Merged

Fix inconsistencies in InternalDocs/parser.md#154917
ZeroIntensity merged 2 commits into
python:mainfrom
YangSiJun528:fix-parser-typo

Conversation

@YangSiJun528

Copy link
Copy Markdown
Contributor

typr in the memoization example appears to be a typo, since return_type is used elsewhere in this document for the same placeholder.

@YangSiJun528
YangSiJun528 requested a review from AA-Turner as a code owner July 30, 2026 10:38
@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir skip news labels Jul 30, 2026
@python-cla-bot

python-cla-bot Bot commented Jul 30, 2026

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.

CLA signed

@picnixz

picnixz commented Jul 30, 2026

Copy link
Copy Markdown
Member

I do not think it is a typo though and I cknsider this not enough for just a typo change. However if you can find more typos in this document itself (or inconsistencies) we could make the contribution more valuable.

@ZeroIntensity

Copy link
Copy Markdown
Member

What do you mean that this isn't a typo? This looks legitimate to me.

I think we should let this one through, as this is a first-time contributor. People often need some momentum to get started contributing, and typo fixes are a good way to get that first kick. (If it were someone scouring through CPython sending a PR for every little typo they see, then that would be different and I agree that we shouldn't encourage that, but this seems normal in nature.)

@YangSiJun528 YangSiJun528 changed the title Fix typo in InternalDocs/parser.md Fix inconsistencies in InternalDocs/parser.md Jul 30, 2026
@YangSiJun528

Copy link
Copy Markdown
Contributor Author

Thank you both for the feedback. I believe typr is a typo because every other generic rule_name[...] example I found in this document uses return_type.

Following the suggestion, I reviewed the rest of the document and fixed two additional issues: an incorrect Markdown link and an extra colon.

@picnixz

picnixz commented Jul 30, 2026

Copy link
Copy Markdown
Member

What do you mean that this isn't a typo? This looks legitimate to me.

It is just a formal name so I would usually prefer that when fixing a typo in a document, the document in its entirety is reviewed. When there is a +/-1 change I never know whether this is the only change to do. But now we have a more complete contribution so thanks!

@ZeroIntensity
ZeroIntensity merged commit 2ac8900 into python:main Jul 31, 2026
33 checks passed
@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs Jul 31, 2026
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

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants