This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Documentation formatting bugs
Type: Stage:
Components: Documentation Versions: Python 2.3
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: fdrake Nosy List: fdrake, loewis
Priority: normal Keywords:

Created on 2003-04-25 18:57 by loewis, last changed 2022-04-10 16:08 by admin. This issue is now closed.

Messages (4)
msg15610 - (view) Author: Martin v. Löwis (loewis) * (Python committer) Date: 2003-04-25 18:57
I found that some of my changes get incorrectly 
formatted, but I don't know how to fix them. Assigning to 
Fred in the hope that he knows the proper incantations.

- HTML version of 4.9.2 (standard encodings):
The table is incorrect in the lines that have an empty 
Aliases column (e.g. cp874). The Alias ought to be 
empty, and "Thai" ought to occur in the third column

- HTML version of 4.9.3 (encodings.IDNA)
The first paragraph starts with a bogus "P>"

- HTML of whatsnew, 17, "Support for internationalized 
domain names": The first line of Python prints as a 
guillemet, not as ">>" Notice that I used a non-
preformatted enviroment so that I could output c-cedilla.

- Postscript version of 4.9.2: the table is overfull in its 
width. It would be ok to wrap the aliases lists as much 
as necessary
msg15611 - (view) Author: Fred Drake (fdrake) (Python committer) Date: 2003-04-30 15:06
Logged In: YES 
user_id=3066

- Standard encodings table: ouch!  I'll see what I can do
about this, but it'll take more time than I can spend right now.

- encodings.idna documentation:  That's a bug in the
formatting software; hopefully I'll be able to fix it. 
Worked around it for now (Doc/lib/libcodecs.tex 1.20).

- What's New document: I've worked around the problem so the
interactive prompt shows up properly, but an extraneous
space is generated at the beginning of the line; not sure
why (Doc/whatsnew/whatsnew23.tex 1.144).

- Postscript:  I expect the PDF to exhibit the same problem.
 This is a general problem for tables with a lot of
horizontal-mode material in LaTeX; I don't know how to work
around this (yet).
msg15612 - (view) Author: Fred Drake (fdrake) (Python committer) Date: 2003-09-04 21:26
Logged In: YES 
user_id=3066

Fixed table generation in HTML that caused cells to be
dropped in the standard encodings table in
Doc/perl/python.perl revision 1.140.
msg15613 - (view) Author: Fred Drake (fdrake) (Python committer) Date: 2003-09-06 17:58
Logged In: YES 
user_id=3066

The original problem in the "What's New" document is worked
around in the current CVS version of the formatting tools,
so I no longer consider that to be an issue.

The only remaining problem of those described in this report
is the overly-wide tables in the PDF and PostScript formats,
and that's a well known problem in the Python documentation.

Closing this report as "fixed as we can make it for now."
History
Date User Action Args
2022-04-10 16:08:20adminsetgithub: 38366
2003-04-25 18:57:59loewiscreate