summaryrefslogtreecommitdiffstats
path: root/Doc
Commit message (Collapse)AuthorAgeFilesLines
* Use \manpage{} markup for referencing a UNIX man page.Fred Drake1998-02-172-10/+10
| | | | Added index entry for DES cipher.
* Added comment explaining the only warning produced by makeindex, since thereFred Drake1998-02-172-0/+28
| | | | doesn't appear to be a way to fix that's reasonable.
* Remove Macintosh ligatures item. Solution: Update your Times fonts.Fred Drake1998-02-171-2/+2
| | | | Added native package semantics note.
* Started a TODO list with the latest bug reports.Fred Drake1998-02-171-0/+9
| | | | In part prompted by questions from AMK.
* Clarified comment about the PS generation when using the all-pdf target.Fred Drake1998-02-171-3/+3
|
* Add magic to make PDF generation use maximal compression.Fred Drake1998-02-171-0/+3
|
* Added all-formats target: use this to get both PDF and PS files; using theFred Drake1998-02-171-5/+11
| | | | | | | | | | "alternate" rules for PDF generation doesn't ensure the PS files get generated since distiller isn't used. Switch to the "alternate" rules for PDF generation; this is starting to make more sense than the distiller-based rule, and requires only free software. I'm also confident it's working well (meaning I paged through all four pdflatex-generated PDF files).
* Updated date for interim documentation release.Fred Drake1998-02-172-2/+2
|
* If generating PDF, include the author and title information in acroread'sFred Drake1998-02-171-1/+12
| | | | "File->General Info" dialog.
* Massive changes. Fewer warnings from the Python Library Reference. StillFred Drake1998-02-172-186/+262
| | | | | | | | messy, but the thing seems to be working without bombing completely today. Formatting lib.texi with TeX doesn't seem to do too badly, either! Info formatting isn't quite there; that might just have to disappear this time.
* Update indexsubitem for file attributes correctly.Fred Drake1998-02-172-2/+6
|
* \nodename{} must appear immediately after \section{} for the info conversion.Fred Drake1998-02-172-2/+2
|
* Indent {verbatim} environments like in the printed version.Fred Drake1998-02-161-0/+7
|
* Move optional package inclusions to the top, to make them easier to find.Fred Drake1998-02-161-5/+51
| | | | | | | | | | | | | Code elsewhere in this file tests for the inclusion of the package and does not need to be uncommented. Comments explain what they do and how to disable them. Added support for the optional "fancyhdr" package. If used, page footers include chapter information on the left and section information on the right. Both optional packages, "fancyhdr" and "times", are enabled by default. We may want to disable them before shipping, but I'm not completely convinced. (How many installations format their own documentation?)
* NNTP.xgtitle() description: Add a missing ")" from the response valueFred Drake1998-02-162-4/+8
| | | | | | description. NNTP.xover() description: Adjust some markup for consistency.
* Made the area for wildcards in the description wider, so we don't invade theFred Drake1998-02-162-12/+14
| | | | left margin.
* Fixed formatting of the program name for crypt.Fred Drake1998-02-162-2/+4
| | | | Added another index entry.
* In the example file name, use the current Python version, not a hardcodedFred Drake1998-02-162-14/+14
| | | | | | value. Use logical markup.
* For the lists which describe the regular expression syntax, increase theFred Drake1998-02-162-8/+14
| | | | width available so we don't run into the left page margin.
* Use \version to get the current Python version number, where possible. ThisFred Drake1998-02-162-12/+12
| | | | can only be done in the running text, and not in {verbatim} environments.
* Mark up filename extensions consistently.Fred Drake1998-02-162-42/+42
| | | | Logical markup.
* Added rule to generate the PDF format using pdflatex. Commented out sinceFred Drake1998-02-161-0/+12
| | | | this is still experimental software. See the comment.
* Removed various "(New in 1.5a?!)" constructs. Other notes pertaining toFred Drake1998-02-162-44/+6
| | | | versioning remain intact.
* Break up some long lines in the generated header & footer.Fred Drake1998-02-161-2/+2
|
* "--" --> "---" in two places.Fred Drake1998-02-162-4/+4
|
* Place C typedef for Py_complex after brief description, to be more consistentFred Drake1998-02-162-64/+84
| | | | | | with the other example of a structure description (struct _frozen). Added index entries for the modules referenced in the document.
* Added index enties for the Python built-in functions, where appropriate.Fred Drake1998-02-162-24/+30
|
* Lots of nitty-gritty stuff:Fred Drake1998-02-162-1268/+1368
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Use \emph{} when referring to title of any of the Python manuals, like is done in the other manuals. In some places, use \emph{} or \dfn{} instead of ``...''. Use \samp{} instead of \code{} when marking identifier prefixes. Use logical markup wherever it made sense. Fixed a bunch of typos. In several places, use "---" instead of "--" to get the emdash. Start sentences with capital letters and end them with periods, as needed. "it's" --> "its" in many places: "it's" it *always* a contraction of "it is", and "its" should always be used for the possessive. "don't" --> "doesn't" "should discards any" --> "should discard any" In C function descriptions, use \var{} to mark parameters in the running text instead of \code{}. This matches usage in the other manauls better, and is more consistent with the formatting of the function signatures. Lots of little changes to implement this. Lots of fixups needed due to appearant heavy cut-&-paste in the orignal document. Mention that the exception objects may be either classes or strings, depending on the use of -X; they were unequivocally stated to be strings in the section "Standard Exceptions". "mkvalue()" --> "Py_BuildValue()" Description of PyNumber_Power() indicates that the third value is option, but not how to indicate that it was omitted. Clarified. Explain the behavior of PyString_FromStringAndSize() if the buffer is NULL. Explain the Py_complex structure a little (tell what it's used for) and use a {verbatim} environment for the structure definition itself. Fix explanation of PyFile_SoftSpace(). Update the example version string to 1.5. Combined the sections on defining new object types.
* Make sure indexes begin on odd-numbered pages.Fred Drake1998-02-161-0/+1
|
* Normalization of markup.Fred Drake1998-02-132-22/+22
|
* Don't capitalize identifiers at the beginning of the sentence; re-write toFred Drake1998-02-132-14/+10
| | | | place them elsewhere so they get the right capitalization.
* Fix some markup so that the right characters are printed.Fred Drake1998-02-132-10/+10
| | | | "EOF" --> "\EOF{}"
* Capitalize subsection title.Fred Drake1998-02-132-2/+2
|
* Make one paragraph wrap a little better.Fred Drake1998-02-132-2/+2
|
* Capitalize first word in sentences, use periods at end.Fred Drake1998-02-132-6/+6
|
* Change {datadesc} environments with empty descriptions to \dataline{}s; thisFred Drake1998-02-132-48/+24
| | | | | | removes extra vertical space from the list of names, and makes the display more similar to that used in the socket module, where several constants share a description.
* In description of sound_similar(), break up the markup for longFred Drake1998-02-132-2/+4
| | | | | \code{} at each embedded space, so that the words will wrap. This keeps it from being too ugly.
* In description of __import__, second paragraph, break up the markup for longFred Drake1998-02-132-10/+12
| | | | | \code{} at each embedded space, so that the words will wrap. This keeps it from running off the side of the page, and is only slightly weird.
* Minor stuff:Fred Drake1998-02-132-36/+96
| | | | | | | | | | | | | | Explain what happens when a negative shift count is used (what exception). Mark the title "Python Reference Manual" as \emph{}, for consistency. "info" --> "information" Tell more about the data attributes of file objects, using the {datadesc} environment. When refering the user to the language reference for information about internal types, tell what internal types to expect information on.
* Fix weirdness with single-page table of contents, reported by Guido.Fred Drake1998-02-131-1/+1
|
* &do_env_datadescni,Fred Drake1998-02-131-2/+29
| | | | | | | | &do_env_funcdescni: New functions. These support the non-indexing variety of the {datadesc} and {funcdesc} environments. There's still some flakiness with the new indexsubitem support, but that's low priority.
* Add "Pretty Good Privacy" as well as "PGP" to the index.Fred Drake1998-02-132-0/+2
|
* In add_label_data() description, use "\samp{}" instead of "``\code{...}''"Fred Drake1998-02-132-6/+6
| | | | to indicate the interpreted letters from the format string.
* Use "\samp{...}" instead of "``\code{...}''" when showing markup fragmentsFred Drake1998-02-132-36/+36
| | | | | | | | | | in the running text. For computed attribute and method names (where there's a \var{} part to the name), use the non-indexing forms of \datadesc{} and \funcdesc{}. This doesn't change the printed output, but removes 3 rejections from the makeindex run and allows the LaTeX2HTML support to exclude these from the index.
* Use "\samp{...}" instead of "``\code{...}''" when showing markup fragmentsFred Drake1998-02-132-32/+32
| | | | | | | | | in the running text. For computed method names (where there's a \var{} part to the name), use the non-indexing form of \funcdesc{}. This doesn't change the printed output, but removes 3 rejections from the makeindex run and allows the LaTeX2HTML support to exclude these from the index.
* Two new environments: datadescni and funcdescni. These are similar toFred Drake1998-02-131-3/+17
| | | | datadesc and funcdesc, but don't add entries to the index.
* &get_indexsubitem: This now has a chance of working, thanks to:Fred Drake1998-02-131-233/+256
| | | | | | | | | | | | | &do_cmd_setindexsubitem: New function. Set the indexsubitem value from \setindexsubitem{(...)}. &do_env_opcodedesc: By default, don't index byte codes. $INDEX_OPCODES: New flag. If true, index the byte codes. Default is off. Normalize indentation to 4 spaces everywhere. Minor nits.
* Remove \bcode / \ecode everywhere.Fred Drake1998-02-132-1398/+1280
| | | | | | | | | Make all the indentations in {verbatim} environments have column 0 of the listing in column 0 of the file. Remove pagenumbering / pagestyle cruft. Use more logical and less physical markup.
* Remove \bcode / \ecode everywhere.Fred Drake1998-02-132-296/+286
| | | | | | | Make all the indentations in {verbatim} environments have column 0 of the listing in column 0 of the file. Remove pagenumbering / pagestyle cruft.
* Remove obsolete pagenumbering / pagestyle cruft.Fred Drake1998-02-134-20/+0
|