Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity
10,855 Commits 6 Branches 592 Tags 2.4 GiB
Commit Graph

2443 Commits

Author SHA1 Message Date
Fred Drake a694e00085 Remove \platform declaration; this module is generic. 1999-04-22 15:14:11 +00:00
Fred Drake 5254a6d682 Move stat to the Generic chapter. 1999-04-22 15:01:44 +00:00
Fred Drake ca69a03dd6 Don't refer to the system documentation as "man pages"; too 
Unix-centric.  Note that this can be used with the output of
os.fstat() as well as os.stat() and os.lstat().
 1999-04-22 14:55:43 +00:00
Fred Drake 7bf96ca32d Make an assertion. 1999-04-22 14:16:59 +00:00
Fred Drake 6532b9b8e0 Updated a comment and the release number. 1999-04-22 14:16:14 +00:00
Fred Drake 2ea30f4d8c Add warning that last() and previous() don't work for hashtable 
databases (opened using hashopen()), as noted by Skip Montanaro on
comp.lang.python.
 1999-04-22 14:06:36 +00:00
Fred Drake 693a2c6581 Script to locate uses of \module where the module referred to is not 
the module being documented at that point in the documentation; these
are candidates for conversion to \refmodule, which produces a
hyperlink in the HTML and PDF versions of the output.
 1999-04-22 13:08:09 +00:00
Fred Drake e0208cc83c Add a couple of items. 1999-04-22 13:05:52 +00:00
Fred Drake adade928be Fill in a lot of the blanks. Add a start to the LaTeX primer section. 
Use Python-traditional XXX comments instead of square brackets that
aren't as obvious or usefully grepable.
 1999-04-22 13:05:27 +00:00
Fred Drake 30a535c0f7 Added support for adding environment/macro parameters more cleanly: 
\op adds an optional parameter, and \p adds a required parameter.
These are only defined in the context of the parameter list parameter
of the envdesc and macrodesc environments.
 1999-04-22 13:03:49 +00:00
Fred Drake b9f1f6d90b Misc. markup nits. 
All sections get reasonable file names in the HTML output.
 1999-04-21 21:43:17 +00:00
Fred Drake 2dabd811cd Fix markup typo. 1999-04-21 21:33:24 +00:00
Fred Drake d146edfaf1 Mark the "Notes:" sections under tables the same way it's done 
elsewhere in the library reference.
 1999-04-21 21:15:35 +00:00
Fred Drake b11d108cdc The version information here was checked good in 1999, not 199. ;-) 
Added "See also" reference to zlib home page, even though it's
mentioned in the text.
 1999-04-21 18:44:41 +00:00
Fred Drake 2799f9d09a Reflow paragraph to work around LaTeX2HTML dropping a space. 
Make all references to the os module hyperlinks.
 1999-04-21 18:33:47 +00:00
Fred Drake 6d20caa2ce Reflow paragraph to work around LaTeX2HTML dropping a space. 1999-04-21 18:17:11 +00:00
Fred Drake 543e19d923 Small nits, more hyperlinks. 
Added more information for cStringIO.
 1999-04-21 18:15:22 +00:00
Fred Drake 048b75bd9a Make references to whrandom hyperlinks. 1999-04-21 18:14:22 +00:00
Fred Drake ec6baaf618 Small markup nits. 1999-04-21 18:13:31 +00:00
Fred Drake 54f2fdd1ad Make the names of the referenced modules hyperlinks; they had not been 
marked at all.
 1999-04-21 18:10:08 +00:00
Fred Drake 02e8c0fd2d Nits. Reference to signal module becomes a hyperlink. 1999-04-21 18:01:14 +00:00
Fred Drake 283c588402 Work around LaTeX2HTML comment-handling bug. 1999-04-21 17:57:15 +00:00
Fred Drake 318c0b131f Logical markup nits. 
Make references to other modules hyperlinks.
 1999-04-21 17:29:14 +00:00
Fred Drake c3845a14d3 Logical markup & other small nits. 1999-04-21 17:18:04 +00:00
Fred Drake 11bc8cfee3 Explain *why* the copytree() implementation is presented as the 
example!
 1999-04-21 17:08:51 +00:00
Fred Drake e688aec707 Textual references to the glob module can be hyperlinks. 1999-04-21 17:04:43 +00:00
Fred Drake 737aa552f4 Markup nit to fixed dropped space in HTML output. 1999-04-21 17:01:15 +00:00
Fred Drake 4747f7f61d Markup nits. 1999-04-21 16:41:40 +00:00
Fred Drake 4f6e4fbc1d Added "See also" reference to xdrlib. 
Markup nits.
 1999-04-21 16:38:53 +00:00
Fred Drake 69fa56327a Markup nits. 1999-04-21 16:29:57 +00:00
Fred Drake 8307e21a2a Mark the references to module names use \module or \refmodule (the 
closing paragraph used \code).
 1999-04-21 16:29:18 +00:00
Guido van Rossum 6ed122a334 Important fix mentioned by The Dragon De Monsyne: the sendmail() 
method does _not_ disconnect the connection when it throws a
SMTPHeloError!
 1999-04-21 16:19:16 +00:00
Fred Drake a889add5d6 Oops; minor nit in example: none of the other interactive examples 
show the "trailing" prompt, so don't show it here!
 1999-04-21 16:00:24 +00:00
Fred Drake ca675e491b do_cmd_funcline(): Remove some bogus generated stuff from the output 
(some text was only intended for the index).
 1999-04-21 15:58:58 +00:00
Fred Drake 3d815bd1c7 Added link to xdrlib module in "See also" section. 1999-04-21 15:57:29 +00:00
Fred Drake 085b8121eb Fix some remaining index & consistency nits. (Many data member 
references were being omitted from the general index.)
 1999-04-21 14:00:29 +00:00
Fred Drake c3fcd6fa0e Added index entry for "file objects"; this is appearantly referenced 
somewhere in the Reference Manual, and someone tried to locate it via
the index.  Report on the omission by Stefan Franke
<sfranke@cdc-group.com>.
 1999-04-21 13:58:17 +00:00
Fred Drake 7ceb5777d7 Added doc for the "module" attribute on the class descriptor objects; 
omission repoorted by Glyn Webster <glyn@ninz.org.nz>.
 1999-04-20 18:18:53 +00:00
Fred Drake ad56dafd62 Added example use of pack_list() to help explain the pack_item 
parameter.  Lack of clarity reported by Matthew Gallagher
<hew@hons.cs.usyd.edu.au>.
 1999-04-20 13:41:14 +00:00
Fred Drake 4ae52694c9 Updated to reflect additions. 1999-04-19 21:21:28 +00:00
Fred Drake 32c562bdec colorsys docs from David Ascher. 1999-04-19 21:20:13 +00:00
Fred Drake 9d15881744 bsddb docs from Skip Montanaro; added interesting links. 1999-04-19 21:19:21 +00:00
Fred Drake e9af64c373 Remove superfluous index entry for posix.popen(); no longer 
appropriate since popen() is only documented in os.
 1999-04-16 19:00:48 +00:00
Fred Drake dac9a4e3db Added link to Fredrik Lundh's online Tkinter reference material. 1999-04-16 18:26:22 +00:00
Fred Drake 31bfbc6bff Minor nits, include author info. 1999-04-16 14:03:32 +00:00
Fred Drake 511281ac00 In list of sequence comparison examples, "=" should be "==". Reported 
by Mirko Liss <n89553@hrz.uni-paderborn.de>.
 1999-04-16 13:17:04 +00:00
Fred Drake 0ebd5483be Removed dbhash from the undocumented list. 1999-04-15 16:05:29 +00:00
Fred Drake 460f1dd6b7 Add libdbhash.tex. 1999-04-15 15:12:37 +00:00
Fred Drake 666255f5ac Document the dbhash module, and link to it from appropriate places. 1999-04-15 15:11:40 +00:00
Fred Drake f4cbada3f9 Correct documentation for <file>.read(); Python makes a serious 
best-effort to return 'size' bytes.  Point out that this may mean
multiple fread() calls.  Reported by Anders Hammarquist
<iko@iko.pp.se> via the Debian crew.
 1999-04-14 14:31:53 +00:00
Fred Drake e79f5c1d2b Use the standard stylesheet here as well. 1999-04-14 14:28:48 +00:00
Fred Drake 6ab98325f7 Use the tools/mkdvi.sh script to generate DVI and PDF output for the 
library reference now that it's sufficiently capable.
 1999-04-14 14:04:39 +00:00
Fred Drake c260c0bcdb Further refinement, to allow this to handle the library reference as 
well as the other "manual" documents.
 1999-04-14 13:13:32 +00:00
Fred Drake 011f6fca31 Typo: "Otherwose" --> "Otherwise" (reported by Joakim Sernbrant 
<joakim.sernbrant@front.se>).

Misc. small fixes to the logical markup.
 1999-04-14 12:52:14 +00:00
Fred Drake 79d41ccdd3 Add some support for the module index, so this can be used to build 
the .aux file for any of the "manual" class documents.
 1999-04-14 05:02:06 +00:00
Fred Drake 7a64b355c1 For now, comment out the \ignorePlatformAnnotation; the global index 
doesn't really work with this.
 1999-04-13 22:19:21 +00:00
Fred Drake 9444df0844 Don't include the verbatim style; the default handling is better. 1999-04-13 22:17:55 +00:00
Fred Drake 1cc5899742 Fix problem of LaTeX leakage in the module synopsis tables at the 
beginning of chapters.  Known problem reported by Barry Scott
<barry@scottb.demon.co.uk>.
 1999-04-13 22:08:59 +00:00
Fred Drake e331356ff7 Fix availability declaration for popen2 module; report by Barry Scott 
<barry@scottb.demon.co.uk>.
 1999-04-13 22:03:26 +00:00
Fred Drake b9971b9964 Minor cleanup. 1999-04-13 21:39:31 +00:00
Fred Drake 592dd78408 Fix availability declaration for stat module; report by Barry Scott 
<barry@scottb.demon.co.uk>.
 1999-04-13 21:38:02 +00:00
Fred Drake 31ec33ed60 Work around problems with HTML conversion by making the break and 
tbreak synopses be all on one line (each).  Known problem, most
recently reported by Barry Scott <barry@scottb.demon.co.uk>.
 1999-04-13 21:36:44 +00:00
Fred Drake cc10e0469a Just in case a copy of the documentation gets released somehow... 1999-04-13 21:22:46 +00:00
Fred Drake 07bd1d1b7b Ignore the doc/ directory ("Documenting Python"). 1999-04-12 15:41:44 +00:00
Fred Drake bfb092eb86 Misspellling: "occurance" --> "occurrence" 1999-04-09 19:57:09 +00:00
Fred Drake 2e1094e4ef Use #!/usr/bin/env python instead of #!/usr/local/bin/python. 1999-04-09 14:53:35 +00:00
Guido van Rossum 7969f31c4d Updated documentation by Per Cederqvist. I've added back the 
documentation sendmail() to reflect the changes by The Dragon
(see smtplib.py checkin).
 1999-04-07 15:56:51 +00:00
Fred Drake 4f21d54764 Added more "See also" entries, + 1 inline hyperlink. 1999-04-05 22:18:12 +00:00
Fred Drake ea003fcc2a Fixed latex2html weirdness with footnotes. 1999-04-05 21:59:15 +00:00
Jeremy Hylton 45b0aeda3c correct version info for zlib. 
add note about module failing with old versions of the library.

update comment that explains that this doc is *still* out of date
 1999-04-05 21:55:21 +00:00
Fred Drake 93aa0f23a7 Fixed latex2html weirdness with footnotes. 1999-04-05 21:39:17 +00:00
Fred Drake b55ce1e8b6 Fixed latex2html weirdness with footnotes. 1999-04-05 21:32:52 +00:00
Fred Drake 52e2d51ef3 Fixed latex2html weirdness for a footnote. 1999-04-05 21:26:37 +00:00
Fred Drake 9aa8543c84 open() description: Made it more clear that 'b' should always be 
added to the mode value for binary files to improve
	portability.

Fixed latex2html weirdness with a couple of footnotes.
 1999-04-05 21:22:41 +00:00
Fred Drake 01553706bf Added a few items to the "See also" sections at Guido's prompting. Made 
more references to other modules in the text hyperlinks for the HTML and
PDF versions.
 1999-04-05 19:46:21 +00:00
Fred Drake 766e0cbde1 Added "doc" target to match the other document-prefix targets. 1999-04-05 19:28:29 +00:00
Fred Drake 50ae47b0de Removed bosities around example code; not sure where that stuff crept 
in!
 1999-04-05 19:26:16 +00:00
Fred Drake 1dc3a501a6 Made improvements based on changes just made and comments from 
Bernhard Reiter <bernhard@csd.uwm.edu>.
 1999-04-05 19:00:54 +00:00
Fred Drake 275e83489e Added "Documenting Python" to the index. 1999-03-30 13:43:54 +00:00
Fred Drake 2c4e009b66 Fixed a lot of the smaller nits identified in Guido's comments. 
Filled in some of the "blank" areas, and added another large blank
area for a LaTeX primer.  (Still a lot to be done.)
 1999-03-29 14:55:55 +00:00
Fred Drake 806a467fbf Where rfc822.Message is mentioned, add a link to the rfc822 module. 1999-03-27 05:45:46 +00:00
Fred Drake 7c6a90de8a Added some rules that affect those little "See also:" sections. 1999-03-25 22:22:45 +00:00
Fred Drake bb584d3f6e Be more stylesheet friendly. 1999-03-25 22:18:30 +00:00
Fred Drake a608a1df87 Require the verbatim package (similar to the LaTeX version). 1999-03-25 22:17:29 +00:00
Guido van Rossum cb1f2420ea Document complex() with string arg. 1999-03-25 21:23:26 +00:00
Guido van Rossum 5fc9c869dd SIGTERM is no longer caught to call sys.exitfunc. 
This change was made long ago but the documentation was never updated.
 1999-03-25 20:30:00 +00:00
Fred Drake 2cafcbb440 Remove \platformof support, since it's been removed from the LaTeX 
style sheet.

Small nits.
 1999-03-25 16:57:04 +00:00
Fred Drake e82f5b3d6e Added note about ftpmirror.py, since that seems to be one of the most 
requested Python tools/examples.
 1999-03-25 05:04:17 +00:00
Fred Drake 9b8afdee44 Use more recent option to \pdfdest to not change the zoom factor. 
This is in response to a comment from Wes Rishel <wes@rishel.com>.
 1999-03-24 14:16:17 +00:00
Guido van Rossum 8be229650d Document new builtin buffer(). Greg Stein. 1999-03-19 19:10:14 +00:00
Fred Drake 7d5f5dd6aa Added htmldoc, to generate the HTML for "Documenting Python". 1999-03-18 19:08:47 +00:00
Fred Drake 1468d77ff8 Add "Documenting Python" to the list of processed documents. 1999-03-18 19:07:04 +00:00
Fred Drake 03dffcce0e LaTeX2HTML support for the ltxmarkup package. 1999-03-18 16:42:28 +00:00
Fred Drake 9466b9a10d Add some (commented out) macros to change the page size to the size of 
typical published manuals, so people can more easily see what they're
really asking for.  ;-)

Revise the verbatim environment: simple implementation, but more
compatible if a document also add \usepackage{verbatim} at the
beginning.

Declare \modindex, \bimodindex, \exmodindex, and \stmodindex
obsolete.  These still work just fine, but \declaremodule should be
used instead.  The obsolete macros will print a warning on standard
out.
 1999-03-18 16:18:27 +00:00
Fred Drake 596766772e Documented FTP.set_pasv(). 1999-03-18 16:08:54 +00:00
Fred Drake e3fd1064de Make this simpler; don't care about the paper size. Require that the 
files exist in the current directory.

Add "Documenting Python" to the list of documents listed.
 1999-03-18 14:57:53 +00:00
Fred Drake 154d909993 Note that abspath() was added in 1.5.2. 1999-03-17 22:25:11 +00:00
Fred Drake 90fc0a71a5 Be sure "make" understands the "doc" target is phony. 1999-03-17 16:06:51 +00:00
Fred Drake 8d2c0c2ab4 Fixed minor nits, added index entries to make these easier to find for people 
not familiar with Unix terminology.
 1999-03-16 16:40:01 +00:00
Fred Drake c43e6a2f31 Ignore some more files kept by mkhowto --keep. 1999-03-16 16:14:51 +00:00
Fred Drake 15087437d5 Add support for "Documenting Python". 1999-03-16 16:11:27 +00:00
Fred Drake 8df362cf97 Removed the embedded sections showing module documentation; just 
\input the module template.
 1999-03-16 16:10:31 +00:00
Fred Drake acffaee46e New document: "Documenting Python". 1999-03-16 16:09:13 +00:00
Fred Drake 1d8f07acbd Markup for documenting LaTeX macros and environments. 1999-03-16 16:08:26 +00:00
Fred Drake f03fdbc063 Added the new sections from Skip Montanaro. 1999-03-15 15:47:30 +00:00
Fred Drake 658cef0141 Preliminary mhlib and telnetlib documents from Skip Montanaro -- thanks, Skip! 1999-03-15 15:44:18 +00:00
Fred Drake bf5a6d2eb4 Fixed tons of small markup problems. 1999-03-12 19:57:38 +00:00
Fred Drake b3a20bc44c Added availabililty annotations to respond to concerns of /F. 1999-03-12 18:34:21 +00:00
Fred Drake 4b1a07ae18 Fixed grammatical error reported by Donald Wallace Rouse II 
<dwr2@ix.netcom.com>.
 1999-03-12 18:21:32 +00:00
Fred Drake 93503ca57b Fixup the module keys. There were some problems with hosting / processing 
file HTML files on Windows machines do to case insensitivity.
 1999-03-12 16:24:22 +00:00
Fred Drake be110c1706 Updates based on comments from /F. 1999-03-12 15:27:35 +00:00
Fred Drake 87a42cd61b Add support for <platform>, some cleanup of module section after 
creating the <moduleinfo>.
 1999-03-11 17:35:12 +00:00
Fred Drake ee84d5972f Lots of nits to respond to various comments from users. 1999-03-10 17:25:30 +00:00
Fred Drake dc12ec8ca0 Fix a number of typos and small grammatical nits pointed out by Detlef 
Lannert <lannert@lannert.rz.uni-duesseldorf.de>.

Added a comment explaining the cast in the method table for the
keyword arguments sample code, in response to another comment by
Detlef.
 1999-03-09 18:36:55 +00:00
Fred Drake 39fc1bc329 Added note about __builtin__._ to section dicussing classes of 
reserved names, just to avoid confusion on the part of users.
 1999-03-05 18:30:21 +00:00
Fred Drake 1acb8740eb Oops, missed a couple of substitutions in the templates. 1999-03-04 21:33:55 +00:00
Fred Drake b41f97d6a0 Pass in the 'Send comments to ...' on the mkmodindex command line, 
just like we do for mkhowto.
 1999-03-04 21:25:05 +00:00
Fred Drake 5f7832d125 Allow many more aspects of the generated page to be parameterized, and 
add a useful usage message.  Use 'mkmodindex --help' to display it.
 1999-03-04 21:19:57 +00:00
Fred Drake 6de28bd2a8 Added "Internet Config" to index. 1999-03-04 19:00:26 +00:00
Fred Drake 62cc360e38 add_module_idx(): If \ignorePlatformAnnotation is used, only ignore 
the specified annotation, not any annotation.
 1999-03-04 18:41:17 +00:00
Fred Drake 35c3ffdc3f Fixed description of WSTOPSIG(), added WTERMSIG(). Problem reported 
by Jonathan Giddy <jon@dgs.monash.edu.au>.
 1999-03-04 14:08:10 +00:00
Fred Drake aaa0d9a3a4 Record the value of $TEXINPUTS in the transcript. 
Job.message():  New method.  Takes care of writing a message to the
		user and adding it to the transcript.
 1999-03-03 21:57:58 +00:00
Fred Drake d8ee0e6ca5 Oops, missed version number for pdfTeX. Updated. 1999-03-03 21:44:10 +00:00
Fred Drake 41dee84a40 Lots of small updates. 1999-03-03 21:39:19 +00:00
Fred Drake b1d839866c Obsolete; use the Python version instead. 1999-03-03 20:28:17 +00:00
Fred Drake 6b12b1ec1d Switch to the Python version of mkhowto. 1999-03-03 20:27:10 +00:00
Fred Drake 8b88093b95 Re-written mkhowto in Python; this should be at least a little more 
portable.

Several things that had been done by running a python script are now a
matter of importing the right module and running a function with a few
parameters.
 1999-03-03 20:24:30 +00:00
Fred Drake 749f943a6b process(): New function that contains the "orchestration" of the 
actual work.

main():  Just handle the command line and filename determination,
	 calling process() to do the work.

These changes make this more import-friendly.
 1999-03-03 19:36:23 +00:00
Fred Drake 7c8754fafb process(): New function that contains the "orchestration" of the 
actual work.

main():  Just handle the command line and filename determination,
	 calling process() to do the work.

These changes make this more import-friendly.
 1999-03-03 19:25:56 +00:00
Fred Drake aa99a5071e Be a little more friendly for the generation of the text version: for 
"blank" navigation icons, use ALT="" instead of ALT="blank"; also add
ALIGN=CENTER for the table, to get a slightly better affect in the
text (the table is full-width, so this doesn't change the appearance
when browsing the HTML).
 1999-03-03 16:21:34 +00:00
Fred Drake a54a887f66 "\platform{UNIX}" should really be spelled "\platform{Unix}". 1999-03-02 17:03:42 +00:00
Fred Drake f6863c1909 Added \platform annotations. 1999-03-02 16:37:17 +00:00
Fred Drake 46a9438c43 Add information about adding the portability statement. 1999-03-02 16:24:22 +00:00
Fred Drake 7f492ad7b8 Be more flexible to support platform annotations. 1999-03-02 16:22:56 +00:00
Fred Drake 75ab7a6fa4 Clean up *.pla files -- platform annotation information. 1999-03-02 16:22:26 +00:00
Fred Drake 521835c541 Ignore *.pla -- the platform annotation information. Also, remove it for 
'make clean'.
 1999-03-02 16:20:42 +00:00
Fred Drake d70091eade Ignore *.pla -- the platform annotation information. 1999-03-02 16:19:37 +00:00
Fred Drake 0c275fa856 Added support for \platform, \platformof, and \ignorePlatformAnnotation. 1999-03-02 16:17:44 +00:00
Fred Drake 557460cb7a swallow_newline(): Removed function; not really needed. Modified all call 
sites.

do_cmd_ignorePlatformAnnotation(),
do_cmd_platform(),
do_cmd_platformof():  New functions to support platform dependency
		      information.

process_all_platformofs():  New function to post-process \platformof macros
	using information collected during the initial pass.

process_python_state():  New function. Call all post-processing functions
	defined in this file to avoid having to have too much knowledge of
	the internals for this stuff in l2hinit.perl.
 1999-03-02 16:05:35 +00:00
Fred Drake 2383f6dbbc Improve handling of module index, to deal with platform annotations a little 
better.
 1999-03-02 16:00:37 +00:00
Fred Drake 01bc01c82e Changes to accomodate the global module index and platform annotations. 1999-03-02 15:58:20 +00:00
Fred Drake 368b16ad2b Only use 4 columns in the module index, to accomodate platform annotations. 1999-03-02 15:56:19 +00:00
Fred Drake 43b34da656 extract_tb(): Only describe this function once. Problem reported by 
Jonathan Giddy <jon@dgs.monash.edu.au>.
 1999-02-26 18:51:21 +00:00
Fred Drake 390636382a Typo: "Availabilty" --> "Availability" 
Thanks to /F!
 1999-02-26 14:05:02 +00:00
Fred Drake 51027c4173 Added note about comments, from Christopher Petrilli. 1999-02-24 22:36:44 +00:00
Fred Drake 16e81f4484 Update some of the top comments and shorten title of the first 
section.
 1999-02-24 19:57:14 +00:00
Fred Drake 093c97a36f ignore_from_idx(): Fixed bug in regular expression. 1999-02-24 18:39:47 +00:00
Fred Drake 684f78fafe Add target for modindex.html; a combined lib+mac module index. Also 
built with target "all".
 1999-02-24 17:34:12 +00:00
Fred Drake 2ef38a7a42 Script to combine module index files. Given a list of files that look 
like modindex.html, create a combined modindex.html file that lists
all the modules.  Takes the same parameters as buildindex.py.
 1999-02-24 17:33:07 +00:00
Fred Drake 1b102456a6 Ignore a file called modindex.html. 1999-02-24 17:13:54 +00:00