python / cpython

The Python programming language
https://www.python.org
Other
63.49k stars 30.41k forks source link

Several minor doc issues #66803

Closed zware closed 10 years ago

zware commented 10 years ago
BPO 22613
Nosy @birkenfeld, @berkerpeksag, @zware
Files
  • PythonDocErreurs141010.pdf
  • Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields: ```python assignee = None closed_at = created_at = labels = ['easy', 'type-feature', 'docs'] title = 'Several minor doc issues' updated_at = user = 'https://github.com/zware' ``` bugs.python.org fields: ```python activity = actor = 'berker.peksag' assignee = 'docs@python' closed = True closed_date = closer = 'georg.brandl' components = ['Documentation'] creation = creator = 'zach.ware' dependencies = [] files = ['36883'] hgrepos = [] issue_num = 22613 keywords = ['easy'] message_count = 6.0 messages = ['229104', '229111', '229112', '230326', '230327', '230328'] nosy_count = 5.0 nosy_names = ['georg.brandl', 'docs@python', 'python-dev', 'berker.peksag', 'zach.ware'] pr_nums = [] priority = 'normal' resolution = 'fixed' stage = 'resolved' status = 'closed' superseder = None type = 'enhancement' url = 'https://bugs.python.org/issue22613' versions = ['Python 3.4', 'Python 3.5'] ```

    zware commented 10 years ago

    From docs@:

    """ Hello,

    First, I want to thank you for the useful and clear documentation of Python.

    Beeing a fanatic reader of it, sometimes I encounter some mistake (or it seems to me it is such). If this could bring some help, you will find in the attached file a list of points requiring attention.

    All the comments concern the official standard documentation of Python 3.4.0.

    With regards.

    Jacques Ducasse """

    berkerpeksag commented 10 years ago

    Repr.repr_TYPE()

    This is already fixed in bpo-14824.

    1762cc99-3127-4a62-9baf-30c3d0f51ef7 commented 10 years ago

    New changeset 7659f06a3648 by Berker Peksag in branch '3.4': Issue bpo-22613: Fix reprlib.Repr subclass example on Python 3. https://hg.python.org/cpython/rev/7659f06a3648

    New changeset 7394e5f85284 by Berker Peksag in branch 'default': Issue bpo-22613: Fix reprlib.Repr subclass example on Python 3. https://hg.python.org/cpython/rev/7394e5f85284

    1762cc99-3127-4a62-9baf-30c3d0f51ef7 commented 10 years ago

    New changeset f72271f05ea4 by Georg Brandl in branch '3.4': bpo-22613: fix several factual errors in builtin docs (thanks Jacques Ducasse) https://hg.python.org/cpython/rev/f72271f05ea4

    New changeset 5faee3db42a7 by Georg Brandl in branch '3.4': bpo-22613: explain what "buffer" is in the struct documentation (thanks Jacques Ducasse) https://hg.python.org/cpython/rev/5faee3db42a7

    New changeset 7d40eff70601 by Georg Brandl in branch '3.4': bpo-22613: elaborate on arguments of shutil archival functions (thanks Jacques Ducasse) https://hg.python.org/cpython/rev/7d40eff70601

    New changeset 307fd58b9694 by Georg Brandl in branch '3.4': bpo-22613: fix heading levels in tracemalloc docs (thanks Jacques Ducasse) https://hg.python.org/cpython/rev/307fd58b9694

    New changeset 0a217d3d581c by Georg Brandl in branch '3.4': bpo-22613: document Cmd.cmdqueue (thanks Jacques Ducasse) https://hg.python.org/cpython/rev/0a217d3d581c

    New changeset 4089047475c5 by Georg Brandl in branch '3.4': bpo-22613: minor other fixes in library docs (thanks Jacques Ducasse) https://hg.python.org/cpython/rev/4089047475c5

    New changeset 53048571de47 by Georg Brandl in branch '3.4': bpo-22613: remaining corrections in extending/reference docs (thanks Jacques Ducasse) https://hg.python.org/cpython/rev/53048571de47

    1762cc99-3127-4a62-9baf-30c3d0f51ef7 commented 10 years ago

    New changeset 60c6dc1b316f by Georg Brandl in branch '2.7': bpo-22613: document Cmd.cmdqueue (thanks Jacques Ducasse) https://hg.python.org/cpython/rev/60c6dc1b316f

    New changeset d3fd218ef2cf by Georg Brandl in branch '2.7': bpo-22613: minor other fixes in library docs (thanks Jacques Ducasse) https://hg.python.org/cpython/rev/d3fd218ef2cf

    New changeset 9e57654dfdcc by Georg Brandl in branch '2.7': bpo-22613: fix several factual errors in builtin docs (thanks Jacques Ducasse) https://hg.python.org/cpython/rev/9e57654dfdcc

    birkenfeld commented 10 years ago

    All remaining points have been fixed.