summaryrefslogtreecommitdiffstats
path: root/Doc
Commit message (Collapse)AuthorAgeFilesLines
* 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
|
* Remove all \bcode / \ecode cruft; this is no longer needed. See previousFred Drake1998-02-13241-1022/+1024
| | | | | | | | | checkin of myformat.sty. Change "\renewcommand{\indexsubitem}{(...)}" to "\setindexsubitem{(...)}" everywhere. Some other minor nits that I happened to come across.
* Lots of stuff:Fred Drake1998-02-131-71/+126
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Handle most (all?) of the page style / numbering magic here so the documents don't have to do it individually. Revise the \bcode / \ecode stuff so that the {verbatim} environment handles it right directly. \bcode / \ecode will be completely removed from all files (to be checked in momentarily). Have the {verbatim} environment get the samples indented a bit; this appearantly had been attempted in the old code, but didn't work because paragraphs weren't indented. Make all headers, from chapters on down to subparagraphs, have sans-serif titles. \setindexsubitem{}: New macro. Replaces \renewcommand{\indexsubitem{}(...)} everywhere. This allows LaTeX2HTML to be made to work correctly for this. That was near impossible with the old mechanisms. For all {*desc} environments, make the name of the described thing bold as well as monospaced. {opcodedesc} environment: Don't index the byte code names; that doesn't seem terribly useful, and there are a lot of them. \var{}: More magic to make sure that the size is right even if embedded in \file{} or some other macro that uses the sans-serif font in running text. \bfcode{}: New macro. Makes the font \code{} and bold. (Was unreasonable using old LaTeX 2.09.) \file{}: Adjust the size of the sans-serif font a little. \email{}, \url{}, Make these use the same font as \file{}, but not the surrounding single-quotes. Update many comments. Lots of minor nits and a little cleanliness.
* parse_line(): Strip whitespace from the module name.Fred Drake1998-02-132-6/+4
| | | | | main(): Include a comma between the module name and page number, to make the generated index more like the "standard" generated index.
* Clean up some of the definitions related to info generation.Fred Drake1998-02-131-4/+8
|
* "ASCII" --> "\ASCII{}"Fred Drake1998-02-122-6/+6
|
* Added tarpdf target.Fred Drake1998-02-121-11/+22
| | | | | | | Don't remove *.texi & *.info for clean; only for clobber. Don't remake tarballs if not needed (PDF & PS only). HTML tarball is still painful.
* Reorganized a bit. No changed content.Fred Drake1998-02-122-1248/+1234
| | | | Guido, please take a look at new structure, at least the ToC.
* For sections describing the "Foo Protocol", consistently use the capitalizedFred Drake1998-02-122-4/+4
| | | | "Protocol" and not "protocol".
* Py_Exit(status) calls exit(status), not exit(0).Fred Drake1998-02-122-2/+2
|
* Correct description of BUILD_SLICE.Guido van Rossum1998-02-122-8/+8
|
* Comment out the times package in the distributed version.Fred Drake1998-02-121-1/+1
|
* Mark opcode arguments \var{} in the running text.Fred Drake1998-02-122-22/+22
| | | | In IMPORT_NAME description: "is not affect:" --> "is not affected:"
* Use new \authoraddress{}; author's name and address are now separate.Fred Drake1998-02-122-8/+12
| | | | | | Use new \release{}; this is now separate from \date{}. Use \email{} instead of \code{} for email addresses.
* Remove second index entry for UserList.Fred Drake1998-02-122-2/+0
|
* \rfcindex{}: Removed; no longer needed.Fred Drake1998-02-111-21/+136
| | | | | | | | | | | | \file{}: Use a sans-serif font for the filename itself. Use the fncychap.sty package for fancy chapter headings. Replace the \maketitle command with our own format. This is new, but it looks a lot better than the old one. Use \renewcommand instead of \def when extending or overriding standard LaTeX commands. This makes it more LaTeX-like.
* New file. Written by Ulf A. Lindgren <lindgren@ae.chalmers.se>; we haveFred Drake1998-02-112-0/+860
| | | | | | | permission to distribute this without modifications. This is the latest version, directly from Ulf. CTAN:macros/latex/contrib/supported/fncychap/
* Added \nodename; added index entry for UserList.Guido van Rossum1998-02-112-0/+4
|
* Added entries for stat, commands modules.Guido van Rossum1998-02-112-0/+14
|
* Added entries for re, soundex modules.Guido van Rossum1998-02-112-0/+12
|
* Some subtleties suggested by Tamito Kajiyama, including an addedGuido van Rossum1998-02-112-4/+6
| | | | \nodename macro for a section with a very underscriptive title.
* Turn the space in [\^ ...] into a hard space: [\^\ ...].Guido van Rossum1998-02-112-2/+2
|
* Split UserDict and UserList on two separate lines; added entries forGuido van Rossum1998-02-112-2/+16
| | | | modules symbol and token.
* Don't break a long line at an unpleasant point.Guido van Rossum1998-02-112-4/+2
|
* Added missing entry for cmath.Guido van Rossum1998-02-112-0/+6
|
* Replace $math$ with \code{}.Guido van Rossum1998-02-112-2/+2
|