classification
Title: Typos in frame object related code
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 3.4
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, ezio.melotti, pitrou, python-dev, vajrasky
Priority: normal Keywords: patch

Created on 2013-08-06 04:53 by vajrasky, last changed 2013-08-06 21:07 by pitrou. This issue is now closed.

Files
File name Uploaded Description Edit
fix_typo_frame_object.patch vajrasky, 2013-08-06 06:09 review
Messages (5)
msg194523 - (view) Author: Vajrasky Kok (vajrasky) * Date: 2013-08-06 04:53
See the patch for details:

diff -r 438cdc97d8ee Include/frameobject.h
--- a/Include/frameobject.h	Mon Aug 05 23:35:43 2013 +0200
+++ b/Include/frameobject.h	Tue Aug 06 12:38:15 2013 +0800
@@ -36,7 +36,7 @@
            non-generator frames. See the save_exc_state and swap_exc_state
            functions in ceval.c for details of their use. */
     PyObject *f_exc_type, *f_exc_value, *f_exc_traceback;
-    /* Borrowed referenced to a generator, or NULL */
+    /* Borrowed reference to a generator, or NULL */
     PyObject *f_gen;
 
     PyThreadState *f_tstate;
diff -r 438cdc97d8ee Lib/test/test_frame.py
--- a/Lib/test/test_frame.py	Mon Aug 05 23:35:43 2013 +0200
+++ b/Lib/test/test_frame.py	Tue Aug 06 12:38:15 2013 +0800
@@ -93,7 +93,7 @@
 
     @support.cpython_only
     def test_clear_refcycles(self):
-        # .clear() doesn't leave any refcycle behin
+        # .clear() doesn't leave any refcycle behind.
         with support.disable_gc():
             class C:
                 pass


About the second comment, I am not sure to put dot or not. In that file, I saw some comments use dot, others don't.
msg194525 - (view) Author: Ezio Melotti (ezio.melotti) * (Python committer) Date: 2013-08-06 05:13
Can you attach the patch to the issue?
Full stops for one-sentence comments can be omitted.
msg194528 - (view) Author: Vajrasky Kok (vajrasky) * Date: 2013-08-06 06:09
Okay, attached the patch to fix the typo.
msg194576 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2013-08-06 21:07
New changeset 89ce323357db by Antoine Pitrou in branch 'default':
Issue #18665: fix typos.  Patch by Vajrasky Kok.
http://hg.python.org/cpython/rev/89ce323357db
msg194577 - (view) Author: Antoine Pitrou (pitrou) * (Python committer) Date: 2013-08-06 21:07
Thank you :)
History
Date User Action Args
2013-08-06 21:07:33pitrousetstatus: open -> closed
versions: - Python 2.7, Python 3.3
messages: + msg194577

resolution: fixed
stage: needs patch -> resolved
2013-08-06 21:07:08python-devsetnosy: + python-dev
messages: + msg194576
2013-08-06 06:09:19vajraskysetfiles: + fix_typo_frame_object.patch
keywords: + patch
messages: + msg194528
2013-08-06 05:13:02ezio.melottisetversions: + Python 2.7, Python 3.3
nosy: + ezio.melotti

messages: + msg194525

type: enhancement
stage: needs patch
2013-08-06 04:53:20vajraskycreate