classification
Title: Table formatting errors in pydoc
Type: behavior Stage:
Components: Documentation Versions: Python 3.4
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: Artur.de.Sousa.Rocha, docs@python, georg.brandl
Priority: normal Keywords:

Created on 2014-10-02 11:38 by Artur.de.Sousa.Rocha, last changed 2014-10-31 08:27 by georg.brandl. This issue is now closed.

Messages (2)
msg228217 - (view) Author: Artur de Sousa Rocha (Artur.de.Sousa.Rocha) Date: 2014-10-02 11:38
Tables in pydoc are formatted incorrectly -- some lines are missing. Example in Python 3.4.1:

>>> help('TUPLES')
...
+----------------------------+----------------------------------+------------+
| Operation                  | Result                           | Notes      |
+============================+==================================+============+
| "x in s"                   | "True" if an item of *s* is      | (1)        |
+----------------------------+----------------------------------+------------+
| "x not in s"               | "False" if an item of *s* is     | (1)        |
+----------------------------+----------------------------------+------------+
| "s + t"                    | the concatenation of *s* and *t* | (6)(7)     |
+----------------------------+----------------------------------+------------+
| "s * n" or "n * s"         | *n* shallow copies of *s*        | (2)(7)     |
+----------------------------+----------------------------------+------------+
| "s[i]"                     | *i*th item of *s*, origin 0      | (3)        |
+----------------------------+----------------------------------+------------+
| "s[i:j]"                   | slice of *s* from *i* to *j*     | (3)(4)     |
+----------------------------+----------------------------------+------------+
| "s[i:j:k]"                 | slice of *s* from *i* to *j*     | (3)(5)     |
+----------------------------+----------------------------------+------------+
+----------------------------+----------------------------------+------------+
+----------------------------+----------------------------------+------------+
+----------------------------+----------------------------------+------------+
| "s.index(x[, i[, j]])"     | index of the first occurrence of | (8)        |
+----------------------------+----------------------------------+------------+
+----------------------------+----------------------------------+------------+


Older version of the same table in Python 3.2.5 in Cygwin console:

+--------------------+----------------------------------+------------+
| Operation          | Result                           | Notes      |
+====================+==================================+============+
| ``x in s``         | ``True`` if an item of *s* is    | (1)        |
|                    | equal to *x*, else ``False``     |            |
+--------------------+----------------------------------+------------+
| ``x not in s``     | ``False`` if an item of *s* is   | (1)        |
|                    | equal to *x*, else ``True``      |            |
+--------------------+----------------------------------+------------+
| ``s + t``          | the concatenation of *s* and *t* | (6)        |
+--------------------+----------------------------------+------------+
| ``s * n, n * s``   | *n* shallow copies of *s*        | (2)        |
|                    | concatenated                     |            |
+--------------------+----------------------------------+------------+
| ``s[i]``           | *i*th item of *s*, origin 0      | (3)        |
+--------------------+----------------------------------+------------+
| ``s[i:j]``         | slice of *s* from *i* to *j*     | (3)(4)     |
+--------------------+----------------------------------+------------+
| ``s[i:j:k]``       | slice of *s* from *i* to *j*     | (3)(5)     |
|                    | with step *k*                    |            |
+--------------------+----------------------------------+------------+
| ``len(s)``         | length of *s*                    |            |
+--------------------+----------------------------------+------------+
| ``min(s)``         | smallest item of *s*             |            |
+--------------------+----------------------------------+------------+
| ``max(s)``         | largest item of *s*              |            |
+--------------------+----------------------------------+------------+
| ``s.index(i)``     | index of the first occurence of  |            |
|                    | *i* in *s*                       |            |
+--------------------+----------------------------------+------------+
| ``s.count(i)``     | total number of occurences of    |            |
|                    | *i* in *s*                       |            |
+--------------------+----------------------------------+------------+
msg230323 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2014-10-31 08:27
Couldn't reproduce in 3.4.2.
History
Date User Action Args
2014-10-31 08:27:23georg.brandlsetstatus: open -> closed
resolution: fixed
messages: + msg230323
2014-10-02 21:00:18ned.deilysetnosy: + georg.brandl
2014-10-02 11:38:30Artur.de.Sousa.Rochacreate