Skip to content
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

Fixed spelling issues. #17774

Open
wants to merge 11 commits into
base: master
Choose a base branch
from
Open

Fixed spelling issues. #17774

wants to merge 11 commits into from

Conversation

clintaire
Copy link
Sponsor

This pull request addresses several spelling and wording corrections in various files across the mypy repository. These changes are aimed at improving the readability of comments and documentation, ensuring clarity for future developers and contributors.

Changes Made:
№ 1: Corrected spelling errors such as “overriden” to “overridden” and “yields or yield froms” to “yields or yield forms”.
№ 2: Updated in-line comments to enhance their clarity while keeping the original meaning intact.
№ 3: Modified wording in CHANGELOG.md and other files to maintain consistency and precision.

↝ These corrections are purely to improve code readability and documentation quality. No functional changes were made to the codebase.

This comment has been minimized.

This comment has been minimized.

@clintaire clintaire closed this Sep 16, 2024
@clintaire clintaire deleted the c-a branch September 16, 2024 16:31

This comment has been minimized.

@clintaire clintaire restored the c-a branch September 16, 2024 17:01
@clintaire clintaire reopened this Sep 16, 2024

This comment has been minimized.

@@ -2249,7 +2249,7 @@ def visit_member_expr(self, e: MemberExpr) -> None:


class FindYield(TraverserVisitor):
"""Check if an AST contains yields or yield froms."""
"""Check if an AST contains yields or yield forms."""
Copy link

Choose a reason for hiding this comment

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

I think this refers to "yield from" (https://docs.python.org/3/whatsnew/3.3.html#pep-380), so it's written as intended?

Copy link
Sponsor Author

Choose a reason for hiding this comment

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

It seems like "from" is the correct terminology as per PEP 380 (https://docs.python.org/3/whatsnew/3.3.html#pep-380), so the original phrasing is accurate. The update might not be necessary.

@@ -28,7 +28,7 @@ def __init__(
self.functions = functions
self.classes = classes
self.final_names = final_names
# Names of C statics used for Python 3.12 type variable objects.
# Names of C statistics used for Python 3.12 type variable objects.

Choose a reason for hiding this comment

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

I think this refers to "C statics" as in "C static variables". That terminology is used elsewhere in mypyc (example), so I think this is written as intended

Copy link
Sponsor Author

Choose a reason for hiding this comment

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

Thanks for pointing that out! I'll leave it as is since "statics" seems to be the correct terminology.

This comment has been minimized.

Copy link
Contributor

According to mypy_primer, this change doesn't affect type check results on a corpus of open source code. ✅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants