classification
Title: Typo(s) in ``itertools`` documentation reST marker
Type: Stage: needs patch
Components: Documentation Versions: Python 2.6
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: rhettinger Nosy List: fero14041, georg.brandl, rhettinger
Priority: normal Keywords: patch

Created on 2010-01-25 13:29 by fero14041, last changed 2010-01-25 19:47 by fero14041. This issue is now closed.

Files
File name Uploaded Description Edit
fix_7778-typo_in_itertools_documentation.diff fero14041, 2010-01-25 16:10 Fix reST typo in last paragraph of itertools documentation
fix_7778-typo_in_itertools_documentation-literal.diff fero14041, 2010-01-25 16:14 Fix reST typo in last paragraph of itertools documentation, and changing an emphasis for a literal
Messages (5)
msg98286 - (view) Author: Vincent Férotin (fero14041) Date: 2010-01-25 13:29
In Python 2.6 ``itertools`` library documentation is a small typo in last paragraph (``projects/python/branches/release26-maint/Doc/library/itertools.rst``, rev. [77750]), see it at http://docs.python.org/library/itertools.html#recipes .

In the note about how optimizing recipes, ``dotproduct`` example function is not outlined as a code sample. Lines 762-763 should end with double colons (instead of simple), to mark following code as such, in reST format::

   (...) For example, the
   *dotproduct* recipe can be written as::

Note that previous ``*dotproduct*`` ref. could be marked as ``inline literal`` instead of *emphasis*, and then lines become::

   (...) For example, the
   ``dotproduct`` recipe can be written as::
msg98291 - (view) Author: Vincent Férotin (fero14041) Date: 2010-01-25 16:10
Add patch fixing typo for sample code.
msg98292 - (view) Author: Vincent Férotin (fero14041) Date: 2010-01-25 16:14
Add patch fixing typo for sample code, and changing ``dotproduct`` emphasis (``*dotproduct*``) to literal (``\``dotproduct\````).
msg98293 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2010-01-25 19:22
Fixed double colon issue.
Leaving the *dotproduct* markup as-is.
Thanks for the report.
msg98294 - (view) Author: Vincent Férotin (fero14041) Date: 2010-01-25 19:47
Ok, thanks for reviewing and fixing!
History
Date User Action Args
2010-01-25 19:47:51fero14041setmessages: + msg98294
2010-01-25 19:22:22rhettingersetstatus: open -> closed
resolution: fixed
messages: + msg98293
2010-01-25 16:14:27fero14041setfiles: + fix_7778-typo_in_itertools_documentation-literal.diff

messages: + msg98292
2010-01-25 16:10:43fero14041setfiles: + fix_7778-typo_in_itertools_documentation.diff
keywords: + patch
messages: + msg98291
2010-01-25 15:11:16ezio.melottilinkissue7764 dependencies
2010-01-25 15:08:17ezio.melottisetpriority: normal
assignee: georg.brandl -> rhettinger

nosy: + rhettinger
stage: needs patch
2010-01-25 13:29:01fero14041create