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

Fix typos in warnings, docstrings, comments and text files #123597

Merged
merged 2 commits into from
Sep 3, 2024

Conversation

abstractee
Copy link
Contributor

This corrects some typos in comments, docstrings and text files.

Copy link

cpython-cla-bot bot commented Sep 2, 2024

All commit authors signed the Contributor License Agreement.
CLA signed

@bedevere-app
Copy link

bedevere-app bot commented Sep 2, 2024

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

@Wulian233
Copy link
Contributor

Do not modify the idle help.html, as it is automatically generated and the typo was fixed 4 months ago.
e7ba6e9

"referencable" and "referenceable" are both acceptable spellings. Let's just leave this file as it is. https://en.wiktionary.org/wiki/referencable
#123201 (comment)

@@ -401,7 +401,7 @@ static inline Py_ALWAYS_INLINE void Py_DECREF(PyObject *op)
* There are cases where it's safe to use the naive code, but they're brittle.
* For example, if `op` points to a Python integer, you know that destroying
* one of those can't cause problems -- but in part that relies on that
* Python integers aren't currently weakly referencable. Best practice is
* Python integers aren't currently weakly referenceable. Best practice is
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* Python integers aren't currently weakly referenceable. Best practice is
* Python integers aren't currently weakly referencable. Best practice is

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the feedback. Corrected.

Copy link
Contributor

@nineteendo nineteendo Sep 2, 2024

Choose a reason for hiding this comment

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

Aren't both of these changes correct?

@@ -694,7 +694,7 @@ <h3>Shell window<a class="headerlink" href="#shell-window" title="Permalink to t
<p>The editing features described in previous subsections work when entering
code interactively. IDLE’s Shell window also responds to the following:</p>
<ul class="simple">
<li><p><kbd class="kbd compound docutils literal notranslate"><kbd class="kbd docutils literal notranslate">C</kbd>-<kbd class="kbd docutils literal notranslate">c</kbd></kbd> attemps to interrupt statement execution (but may fail).</p></li>
<li><p><kbd class="kbd compound docutils literal notranslate"><kbd class="kbd docutils literal notranslate">C</kbd>-<kbd class="kbd docutils literal notranslate">c</kbd></kbd> attempts to interrupt statement execution (but may fail).</p></li>
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
<li><p><kbd class="kbd compound docutils literal notranslate"><kbd class="kbd docutils literal notranslate">C</kbd>-<kbd class="kbd docutils literal notranslate">c</kbd></kbd> attempts to interrupt statement execution (but may fail).</p></li>
<li><p><kbd class="kbd compound docutils literal notranslate"><kbd class="kbd docutils literal notranslate">C</kbd>-<kbd class="kbd docutils literal notranslate">c</kbd></kbd> attemps to interrupt statement execution (but may fail).</p></li>

Copy link
Contributor Author

@abstractee abstractee Sep 2, 2024

Choose a reason for hiding this comment

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

Removed the file from the commit. Thank you.

Lib/_pyio.py Outdated
@@ -315,7 +315,7 @@ class IOBase(metaclass=abc.ABCMeta):

This class provides dummy implementations for many methods that
derived classes can override selectively; the default implementations
represent a file that cannot be read, written or seeked.
represent a file that cannot be read, written or sought.
Copy link
Contributor

Choose a reason for hiding this comment

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

While I understand this change, I think we can use seeked here. One existing wording is https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/seeked_event which relates to seek operations.

jaraco added a commit to python/importlib_resources that referenced this pull request Sep 2, 2024
Copy link
Member

@jaraco jaraco left a comment

Choose a reason for hiding this comment

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

LGTM (importlib/resources/_common.py).

@hugovk hugovk changed the title Fix typos in comments Fix typos in warnings, docstrings, comments and text files Sep 2, 2024
@vstinner vstinner merged commit 1f4a49e into python:main Sep 3, 2024
32 checks passed
@vstinner
Copy link
Member

vstinner commented Sep 3, 2024

Merged, thanks. I don't think that it's worth it to backport the change.

@terryjreedy
Copy link
Member

terryjreedy commented Sep 3, 2024

I want idlelib changes backported. Since _strptime change will not backport to 3.12, will do new PR after 3.13.0.

@abstractee abstractee deleted the fixed-typos branch September 3, 2024 09:12
jaraco added a commit to python/importlib_resources that referenced this pull request Sep 12, 2024
terryjreedy added a commit to terryjreedy/cpython that referenced this pull request Sep 23, 2024
See python#123597.

(cherry picked from commit 1f4a49e)

Co-authored-by: abstractee
terryjreedy added a commit to terryjreedy/cpython that referenced this pull request Sep 23, 2024
See python#123597.  The typo in Icon/README.txt was fixed
in the unmerged 3.13 backport python#123608 of the
PR that added the text with the typo.

(cherry picked from commit 1f4a49e)

Co-authored-by: abstractee
terryjreedy added a commit that referenced this pull request Sep 23, 2024
See #123597.

(cherry picked from commit 1f4a49e)

Co-authored-by: abstractee
Yhg1s pushed a commit that referenced this pull request Sep 27, 2024
See #123597.  The typo in Icon/README.txt was fixed
in the unmerged 3.13 backport #123608 of the
PR that added the text with the typo.

(cherry picked from commit 1f4a49e)

Co-authored-by: abstractee
zetaloop pushed a commit to zetaloop/IDLE-CN-base that referenced this pull request Nov 4, 2024
See python/cpython#123597.

(cherry picked from commit 1f4a49e)

Co-authored-by: abstractee
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants