[issue16747] Remove 'file' type reference from 'iterable' glossary entry
New submission from Zachary Ware: Here's a patch that changes the reference to :class:`file` in the iterable entry in Doc/glossary.rst to :term:`file objects <file object>`, along with minor grammatical fixes to make it fit, and reflowing of the text. ---------- assignee: docs@python components: Documentation files: iterable_glossary.diff keywords: patch messages: 177911 nosy: docs@python, zach.ware priority: normal severity: normal status: open title: Remove 'file' type reference from 'iterable' glossary entry versions: Python 3.2, Python 3.3, Python 3.4 Added file: http://bugs.python.org/file28392/iterable_glossary.diff _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16747> _______________________________________
Chris Jerdonek added the comment: If you are changing just a few minor things, can you resubmit the patch without reflowing? It will be easier to see what minor things have changed. (It is okay to have the occasional short line to avoid having long lines. Reflowing can be done as part of a separate commit if it is severe.) ---------- nosy: +chris.jerdonek _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16747> _______________________________________
Changes by Ezio Melotti <ezio.melotti@gmail.com>: ---------- nosy: +ezio.melotti _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16747> _______________________________________
Senthil Kumaran added the comment: Hello Zachary, What'wrong with referencing :class:`file` for iterable? I find it as OK. Also if it needs to be corrected, the reference could be made for :ref:`bltin-file-objects` Re grammatical fixes, you could point out which were made as with the reflow of the text, it is difficult to spot the fix. ---------- nosy: +orsenthil _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16747> _______________________________________
R. David Murray added the comment: senthil: the file type doesn't exist any more in python3. ---------- nosy: +r.david.murray _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16747> _______________________________________
Senthil Kumaran added the comment: Oh Okay, Thanks! I was checking it against 2.7! On Tue, Jan 1, 2013 at 11:48 AM, R. David Murray <report@bugs.python.org>wrote:
---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16747> _______________________________________
Zachary Ware added the comment: Hi folks, Sorry it's taken me so long to get back to this, it's been a busy month :) Here's the non-reflowed diff. In retrospect, I should have just specifically mentioned the grammatical changes I made in the first place; they were merely to change 'and' between 'dict' and 'file object' to a comma, and add a comma after 'file object'. ---------- Added file: http://bugs.python.org/file28520/iterable_glossary_no-reflow.diff _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16747> _______________________________________
Ezio Melotti added the comment: Yes, that would have been better. I actually prefer reflowing text, but pointing out the changes makes reviewing the patch easier. ---------- assignee: docs@python -> ezio.melotti stage: -> commit review type: -> enhancement _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16747> _______________________________________
Chris Jerdonek added the comment: Changed lines should still be reflowed to respect the column limit. I was just referring to the unchanged lines before and afterwards that shouldn't be reflowed. Not reflowing makes it easier for people viewing diffs on python-checkins and hg.python.org, using hg annotate, etc. to see what has changed. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16747> _______________________________________
Changes by Zachary Ware <zachary.ware@gmail.com>: Added file: http://bugs.python.org/file28525/issue16747.diff _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16747> _______________________________________
Changes by Zachary Ware <zachary.ware@gmail.com>: Removed file: http://bugs.python.org/file28520/iterable_glossary_no-reflow.diff _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16747> _______________________________________
Changes by Zachary Ware <zachary.ware@gmail.com>: Removed file: http://bugs.python.org/file28392/iterable_glossary.diff _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16747> _______________________________________
Roundup Robot added the comment: New changeset 2afc0997e440 by Ezio Melotti in branch '3.2': #16747: fix link to file objects in the glossary. http://hg.python.org/cpython/rev/2afc0997e440 New changeset 6e4fc5e2acf8 by Ezio Melotti in branch '3.3': #16747: merge with 3.2. http://hg.python.org/cpython/rev/6e4fc5e2acf8 New changeset e19ed347523e by Ezio Melotti in branch 'default': #16747: merge with 3.3. http://hg.python.org/cpython/rev/e19ed347523e ---------- nosy: +python-dev _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16747> _______________________________________
Ezio Melotti added the comment: Fixed, thanks for the report and the patch! ---------- resolution: -> fixed stage: commit review -> committed/rejected status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16747> _______________________________________
Roundup Robot added the comment: New changeset dea89ee34402 by Chris Jerdonek in branch '2.7': Issue #16747: Reflow iterable glossary entry to match 3.x change e19ed347523e. http://hg.python.org/cpython/rev/dea89ee34402 ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16747> _______________________________________
Chris Jerdonek added the comment: If you are changing just a few minor things, can you resubmit the patch without reflowing? It will be easier to see what minor things have changed. (It is okay to have the occasional short line to avoid having long lines. Reflowing can be done as part of a separate commit if it is severe.) ---------- nosy: +chris.jerdonek _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16747> _______________________________________
Changes by Ezio Melotti <ezio.melotti@gmail.com>: ---------- nosy: +ezio.melotti _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16747> _______________________________________
Senthil Kumaran added the comment: Hello Zachary, What'wrong with referencing :class:`file` for iterable? I find it as OK. Also if it needs to be corrected, the reference could be made for :ref:`bltin-file-objects` Re grammatical fixes, you could point out which were made as with the reflow of the text, it is difficult to spot the fix. ---------- nosy: +orsenthil _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16747> _______________________________________
R. David Murray added the comment: senthil: the file type doesn't exist any more in python3. ---------- nosy: +r.david.murray _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16747> _______________________________________
Senthil Kumaran added the comment: Oh Okay, Thanks! I was checking it against 2.7! On Tue, Jan 1, 2013 at 11:48 AM, R. David Murray <report@bugs.python.org>wrote:
---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16747> _______________________________________
Zachary Ware added the comment: Hi folks, Sorry it's taken me so long to get back to this, it's been a busy month :) Here's the non-reflowed diff. In retrospect, I should have just specifically mentioned the grammatical changes I made in the first place; they were merely to change 'and' between 'dict' and 'file object' to a comma, and add a comma after 'file object'. ---------- Added file: http://bugs.python.org/file28520/iterable_glossary_no-reflow.diff _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16747> _______________________________________
Ezio Melotti added the comment: Yes, that would have been better. I actually prefer reflowing text, but pointing out the changes makes reviewing the patch easier. ---------- assignee: docs@python -> ezio.melotti stage: -> commit review type: -> enhancement _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16747> _______________________________________
Chris Jerdonek added the comment: Changed lines should still be reflowed to respect the column limit. I was just referring to the unchanged lines before and afterwards that shouldn't be reflowed. Not reflowing makes it easier for people viewing diffs on python-checkins and hg.python.org, using hg annotate, etc. to see what has changed. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16747> _______________________________________
Changes by Zachary Ware <zachary.ware@gmail.com>: Added file: http://bugs.python.org/file28525/issue16747.diff _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16747> _______________________________________
Changes by Zachary Ware <zachary.ware@gmail.com>: Removed file: http://bugs.python.org/file28520/iterable_glossary_no-reflow.diff _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16747> _______________________________________
Changes by Zachary Ware <zachary.ware@gmail.com>: Removed file: http://bugs.python.org/file28392/iterable_glossary.diff _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16747> _______________________________________
Roundup Robot added the comment: New changeset 2afc0997e440 by Ezio Melotti in branch '3.2': #16747: fix link to file objects in the glossary. http://hg.python.org/cpython/rev/2afc0997e440 New changeset 6e4fc5e2acf8 by Ezio Melotti in branch '3.3': #16747: merge with 3.2. http://hg.python.org/cpython/rev/6e4fc5e2acf8 New changeset e19ed347523e by Ezio Melotti in branch 'default': #16747: merge with 3.3. http://hg.python.org/cpython/rev/e19ed347523e ---------- nosy: +python-dev _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16747> _______________________________________
Ezio Melotti added the comment: Fixed, thanks for the report and the patch! ---------- resolution: -> fixed stage: commit review -> committed/rejected status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16747> _______________________________________
Roundup Robot added the comment: New changeset dea89ee34402 by Chris Jerdonek in branch '2.7': Issue #16747: Reflow iterable glossary entry to match 3.x change e19ed347523e. http://hg.python.org/cpython/rev/dea89ee34402 ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16747> _______________________________________
participants (6)
-
Chris Jerdonek -
Ezio Melotti
-
R. David Murray
-
Roundup Robot
-
Senthil Kumaran
-
Zachary Ware