Commit Graph

908 Commits

Author SHA1 Message Date
Fred Drake 53396f66c1 Consistency: In two \section{} headers, change {\tt ...} to \sectcode{...}. 1998-01-19 02:48:37 +00:00
Fred Drake 9e24309bb5 \funcitem{}, \dataitem{}, \excitem{}: Removed obsolete macros; there are no
longer used anywhere.  Use the {*desc} environments instead.

\var{}:  Ensure that the argument is always set in roman italic, in case an
	 alternate font is being used for code.  These keeps the result of
	 \var{} consistent.

Some minor changes to allow easier exploration of alternate fonts for code in
the running text.  Haven't changed the selected font; I haven't found one that
has everything required!  (The best non-monospaced font so far was missing
the <, >, and | characters, or at least had them at the wrong locations.  It
also allowed confusion between upper-case I and lower-case L.)
1998-01-18 05:09:54 +00:00
Fred Drake b660b63edf Use \emph{} for all references to the other documents, not just some of them. 1998-01-16 16:34:34 +00:00
Fred Drake 5081b227f1 Ouch: "accounces" ==> "announces"
(In description of AbstractWriter class.)
1998-01-15 05:49:00 +00:00
Fred Drake af8a015c93 Consistency: "{\bf ...}" ==> "\strong{...}"
"{\em ...}" ==> "\emph{...}"

	      Not at all sure what to do with "{\rm ...}".
	      Leaving it for now.
1998-01-14 14:51:31 +00:00
Fred Drake b215137224 Added the standard \label{module-*} for the two supporting modules. 1998-01-14 05:47:15 +00:00
Fred Drake 8ac34c2928 Consistency: "Unix" ==> "\UNIX{}"
Always include the comma *inside* the \optional{} markup!
1998-01-13 22:41:33 +00:00
Fred Drake 737e73ec3d Augment \tableofcontents to do the right thing. 1998-01-13 22:40:08 +00:00
Fred Drake 4d4f9e726a Removed \mytableofcontents; just use \tableofcontents. 1998-01-13 22:25:02 +00:00
Fred Drake 3e9ce54eff Removed one hack! 1998-01-13 22:23:30 +00:00
Fred Drake a809064166 Consistency: "Unix" ==> "\UNIX{}" 1998-01-13 19:10:02 +00:00
Fred Drake 6862b46b70 Consistency: "unix" ==> "\UNIX{}" 1998-01-13 19:03:36 +00:00
Fred Drake c9dc5151b6 Consistency: "unix" ==> "\UNIX{}"
Added \label{} for referring to the module.
1998-01-13 19:01:57 +00:00
Fred Drake efc1e0f43b Consistency:
"Unix" ==> "\UNIX{}"
1998-01-13 19:00:33 +00:00
Fred Drake 3f20592c3e Consistency:
"Unix" ==> "\UNIX{}"

"C" ==> "\C{}"

"C++" ==> "\Cpp{}"
1998-01-13 18:56:38 +00:00
Fred Drake b0a78738ea Consistency:
"Unix" ==> "\UNIX{}"

"C" ==> "\C{}"

"C++" ==> "\Cpp{}"
1998-01-13 18:51:10 +00:00
Fred Drake 18f9f539f2 Removed obsolete \kwindex{} call.
Added "user configuration file", ".pythonrc.py file" to the index.

Made reference to site module a {seealso} environment.
1998-01-13 18:45:34 +00:00
Fred Drake 2b67bee8e1 Added "module search path" to the index. 1998-01-13 18:35:51 +00:00
Fred Drake cf75754357 Removed obsolete \kwindex{} calls.
Added "module search path" to the index.

"Unix" ==> "\UNIX{}"
1998-01-13 18:34:40 +00:00
Fred Drake bc5062f664 \kwindex{}: Removed obsolete macro. 1998-01-13 18:31:39 +00:00
Fred Drake b5dac4e02e &do_cmd_kwindex: Removed obsolete function. 1998-01-13 18:30:31 +00:00
Fred Drake 8362d005cf Added command at end to use times fonts; commented out. Instructions to use
times are there as well.

Doing it here means the switch only affects one file and gets everything
rebuilt as needed.
1998-01-13 17:29:31 +00:00
Fred Drake 95810e4d18 Removed tarps2, tardvi targets based on comments from Guido.
Added -9 option to gzip.  This doesn't save much space, but it's "free" and
appreaciated by those with slow modems.  (With these tarballs, that means
"those with modems"...!)

Remove the two tarballs in the clean target.
1998-01-13 17:18:57 +00:00
Fred Drake 657cb148c3 After discussion with Guido, agreed to only support double-sided PostScript,
so we'll not need this shell whackery after all.
1998-01-13 16:57:13 +00:00
Fred Drake dca8792b52 Added openright option the the \documentclass{} for each of the manuals. 1998-01-13 16:53:23 +00:00
Fred Drake 33d05b9d88 Added targets:
tarps - one-sided PostScript
  tarps2 - two-sided PostScript, with ref.ps added as-is.
  tardvi - yes, some people want the .dvi files

  all-ps2 - Create the .ps files, but make sure the LaTeX openright option
	    is used in the \documentclass.
1998-01-13 16:33:09 +00:00
Fred Drake bc3b1c6fce Script to add & remove LaTeX \documentclass options. Run "./texoption.sh"
for usage information.
1998-01-13 16:29:08 +00:00
Fred Drake ab0b65d0c9 &make_mod_index_entry: Wrap a long comment, store the additional data needed
to create a module index in the HTML version.
1998-01-13 04:05:11 +00:00
Fred Drake 9b6f1d24f9 Override several functions from the stock latex2html to support the module
index.  It works, it's ugly, and would probably have to be completely redone
if we changed latex2html versions.  See the comments.  ;-(

On the other hand, it works.  ;-)

(Wait for myformat.perl checkin as well.)
1998-01-13 04:03:02 +00:00
Fred Drake 1af9e79708 Added support for \funcline{} and \dataline{}.
For all generated cases of <strong>...</strong> (from this module), change to
<b>...</b>.  This, from me?  This is entirely to reduce the size of the
generated markup, which is more of an issue than semantics here.  Since
<strong> isn't very meaningful anyway, this should be good.
1998-01-12 23:15:29 +00:00
Fred Drake 023f87fbf8 Lots of minor markup nits, all consistency related.
Consistently use trailing "()" on function / method names.

Wrapped some long lines.
1998-01-12 19:16:24 +00:00
Guido van Rossum 97546399c7 Document maxsplit arg for split(), with incompatibility note about 1.5
release bug.

Document groups() changed behaviour (now always returns tuple).
1998-01-12 18:58:53 +00:00
Fred Drake 054f8fd12c Wrapped some long lines.
Added trailing "()" for function and method names.

Added index entries for referenced modules.
1998-01-12 18:28:20 +00:00
Fred Drake 74947ac473 Modify command descriptions to use \optional{} instead of ad-hoc markup.
There are still weirdnesses, but less of them.
1998-01-12 15:38:30 +00:00
Fred Drake 6c886a8db1 \optional{}: Removed leading word space, allowing more flexibility.
{seealso} environment:  Always start a new paragraph after the "See Also:"
	line; this ensures that formatting is consistent for each subsequent
	\see*{} item.
1998-01-12 14:44:33 +00:00
Guido van Rossum b2c45a8197 Sigh. Apply a similar patch to the *other* occurrence of [^...]. 1998-01-12 05:49:05 +00:00
Fred Drake fd49a964bc Follow current recommended practice in an example: Use isinstance() to
perform a type test instead of type(x) == types.FoobarType.  In example
for type().
1998-01-11 21:15:23 +00:00
Fred Drake 48022db400 "Unix" --> "\UNIX{}"
Added index references to referred-to modules.

Added seealso section pointing to the glob module.

Removed description of translate().
1998-01-11 19:06:37 +00:00
Fred Drake 0cf785a7a7 Grammatical nit. 1998-01-09 22:37:52 +00:00
Fred Drake cf7e830869 Add module reference for cPickle to index.
Consistency:  Always use trailing "()" for function and method names in text.

Consistency:  Always mark parameter names with \var{} in text.

Change questionable text about CORBA to definate text about XDR; "CORBA" isn't
enough to specify an external representation, and I'm not sure the comment is
right if we say "IIOP".  I know its right about XDR if we only mention shared
object references and not recursive structures.
1998-01-09 22:36:51 +00:00
Fred Drake 12d9da5827 Use \file{} instead of \code{} or ``\code{}'' to mark file & directory names
& name parts.
1998-01-09 22:30:32 +00:00
Fred Drake 8d0ff317bc Simplify markup. 1998-01-09 22:27:55 +00:00
Fred Drake 57b935d0d6 The resource module has been documented; remove from list. 1998-01-09 22:25:10 +00:00
Fred Drake bbe6068de0 Added \label{} to allow module references.
Added some seealso sections.
1998-01-09 22:24:14 +00:00
Fred Drake aa5dba026a Add index entry for reference to the math module. 1998-01-09 21:30:03 +00:00
Fred Drake d327a8dddf Typographical nits: Always set parameter names in \var{} in the running text. 1998-01-09 21:26:51 +00:00
Fred Drake 6b3ed7f581 Markup consistency in the mapping object interface description. 1998-01-09 20:36:44 +00:00
Fred Drake 0bf6845450 Fix previous nit to really do the right thing. 1998-01-09 16:26:54 +00:00
Fred Drake 60a3d2788e Consistency: Always use lower-case markup; one tag was still given in
uppercase.  (Makes it easier to see what markup is generated by the
	Python manual support and what is generated by standard latex2html.)
1998-01-09 14:39:41 +00:00
Fred Drake 0fd8268189 Revise prologue and frontmatter to use latex2e (not in 2.09 compatibility
mode) and take advantage of changes in myformat.sty.

Change "C" to "\C{}" and "\code{NULL}" to "\NULL{}" everywhere for consistency
and control.

Started a description of PyArg_ParseTupleAndKeywords().
1998-01-09 05:39:38 +00:00
Fred Drake 1f8449af4e Revise prologue and frontmatter to use latex2e (not in 2.09 compatibility
mode) and take advantage of changes in myformat.sty.
1998-01-09 05:36:43 +00:00
Fred Drake 031ad4b2a0 \mytableofcontents New macro. Wrapper around \tableofcontents that
does the right thing if the openright option is given.  Allows a
	lot of crud to be removed from the document files' frontmatter
	sections.

\endabstract		Extend standard macro.  (Called as \end{abstract}.)
	Does the right thing if the openright option is given.

\optional		Adjust to get the brackets right under latex2e.
1998-01-09 05:34:23 +00:00
Fred Drake 46fbd7f4a0 Nit. 1998-01-09 05:22:44 +00:00
Fred Drake 3c3d7ce7fe For consistency, always use a trailing "()" on function names in the running
text.

Add one index entry.
1998-01-08 04:00:30 +00:00
Fred Drake fcda560e81 Fix a typo (the word "a" was spelled "c"!).
Added index entries & \label{} constructs.
1998-01-07 22:05:25 +00:00
Fred Drake c9a32ab26b Normalize some markup.
Use \file{} instead of \code{} for a directory name (Tools/freeze).

Consistently use "()" at the end of a function name in running text.
1998-01-07 18:57:01 +00:00
Fred Drake 6279fccf4c Fixed up index entries.
Adjusted one formatting problem (long \code{} in running text).
1998-01-07 13:23:32 +00:00
Fred Drake 1566a1d72c Added index entry for the protocol.
Fixed typo (extra char in the word "character").

Minor nits.
1998-01-07 13:17:20 +00:00
Fred Drake 15bac5d6e4 Added index items for the RFC and the protocol itself. 1998-01-07 13:13:42 +00:00
Fred Drake 799484399d Fixed index entries to be more consistent. 1998-01-07 03:47:10 +00:00
Fred Drake c4586387f6 In description of \D, revise markup so that the caret shows up in the HTML
version as well as the dvi form.  Without the fix, it showed up as an extra
zero character.

Bug reported by Hugh Sasse <hgs@dmu.ac.uk>.
1998-01-06 15:46:21 +00:00
Fred Drake 85a5c52752 Descriptions for PyRun_String(), PyRun_File(), and PyRun_CompileString() all
gave the return type as part of the function field and used an empty return
type field.  Fixed.

Function name field for PyLong_FromString() included an asterisk at the
beginning of the function name field; removed.
1998-01-02 03:24:19 +00:00
Fred Drake 34252f99d6 lib.dvi target: Added commands to generate the modules index. 1998-01-02 03:01:47 +00:00
Fred Drake c1ce320a4f Script to convert module index data to module index. 1998-01-02 03:00:27 +00:00
Fred Drake 0b1337d674 Add module index before the general index. 1998-01-02 02:59:09 +00:00
Fred Drake da941ef27c Added support for storing information to build a module index.
Enhance the "theindex" environment to add an entry to the table of contents.
1998-01-02 02:57:41 +00:00
Fred Drake 875c807c92 In description of the group() method, fix markup of "\(" and "\)" literals;
"\code{\\(}" produces "(" in the .dvi file and "<BR> (" in the latex2html
output (the font was right).  Changed to "\code{{\e}(}" variation, which
fixes both.  Breaks the .texi file generation again.  Oh well.
1998-01-02 02:50:13 +00:00
Guido van Rossum 3884e7edf9 Apply fixps.py to allow A4 paper printing. 1997-12-30 23:49:49 +00:00
Guido van Rossum 1f35977bfd Added BaseHTTPServer to table of contents for chapter. 1997-12-30 23:42:27 +00:00
Guido van Rossum eb0f066fb8 Correct small nits reported by Rob Hooft. 1997-12-30 20:38:16 +00:00
Guido van Rossum ccd25d10c4 Final version for 1.5; two tiny corrections. 1997-12-30 18:35:35 +00:00
Guido van Rossum 5793039dce Clarify that __getinitargs__ is called at pickle time! 1997-12-30 17:44:48 +00:00
Guido van Rossum 4f80b65aa6 Added "docs" for Pareto and Weibull distributions. 1997-12-30 17:38:05 +00:00
Fred Drake 1c8b9e4769 Clean out *.texi and *.info* as well for "make clean". 1997-12-30 04:57:58 +00:00
Guido van Rossum 7779619524 Add obsolescence note. 1997-12-30 04:54:47 +00:00
Guido van Rossum b1b8f23903 Add URL of Andrew Kuchling's nifty re conversion page... 1997-12-30 04:53:49 +00:00
Guido van Rossum 8e94489882 Add a note that up to 1.4, translate() produced Emacs style syntax; in
1.5, it produces Perl style syntax.  Also change "Python's regular
expressions" into plain "regular expression" in the intro.
1997-12-30 04:43:36 +00:00
Fred Drake e33e903461 Updated release date to match boilerplate.tex.
Removed implied future availability of an info/texi version of the other
manuals (the word "yet").

Guido, you might want to check this file to see if any other changes are
required.
1997-12-30 04:42:49 +00:00
Guido van Rossum 5de1eb9b84 Added ConfigParser.py to list of undocumented miscellaneous useful utilities. 1997-12-30 04:41:56 +00:00
Guido van Rossum dccc298e3d Took out some disclaiming text (even from the title!). Rewritten
abstract.  Alas, I didn't get to do anything else before the release
:-(
1997-12-30 04:40:25 +00:00
Guido van Rossum 5b8a523538 A whole bunch of typos fixed by Andrew Kuchling.
Added a warning about the incompleteness to the front.
Added a reminder about CObject to the back.
1997-12-30 04:38:44 +00:00
Guido van Rossum 5b943ca1a9 Set the release date for 1.5 (final). 1997-12-30 04:29:30 +00:00
Fred Drake 13704a8928 Added .PHONY annotation for lib.info target; the real target is
python-lib.info.  The annotation is needed to prevent at least GNU make from
building a second set of info files with the lib.info base name.
1997-12-29 22:04:44 +00:00
Guido van Rossum e66e9c5562 Remove more commented-out text that is no longer needed. 1997-12-29 21:43:04 +00:00
Guido van Rossum 29d3b9368c Remove the commented-out warning at the top. It shouldn't be there
for the 1.5 release version of the file.
1997-12-29 21:42:03 +00:00
Fred Drake 43c9350f7a Getting uglier. But it doesn't completely bomb except for some table stuff.
I'll get to it when I can.
1997-12-29 21:40:35 +00:00
Fred Drake 78f8e98232 Lots of minor nits that allow this file to get processed without failures by
the info generation phases.  Most of the errors had occurred in the makeinfo
step.

Commented out the warning at the top; this should still really be removed
before 1.5, but that's not my call.  It generated problems for the info
conversion as well.
1997-12-29 21:39:39 +00:00
Fred Drake 6810a29c64 Ignore generated info files. 1997-12-29 21:37:21 +00:00
Fred Drake a007c13094 Reduce warning count from partparse.py.
Removed BaseHTTPServer.py from list of undocumented modules.
1997-12-29 21:32:26 +00:00
Fred Drake 3d913ad370 Revised lib1.texi target to deal with some conversion nastiness. See comment. 1997-12-29 21:31:23 +00:00
Fred Drake 1b6cf78c15 Reduce warning count from partparse.py. 1997-12-29 20:28:33 +00:00
Fred Drake 588f38ec2a Ignore another intermediate file from the info generation. 1997-12-29 20:03:46 +00:00
Fred Drake d7feffdd5f Reduce warning count from partparse.py. 1997-12-29 20:02:55 +00:00
Guido van Rossum 9cb64803aa Added Greg Stein's docs for BaseHTTPServer.py.
Moved docs for "re" to before docs for "regex".
1997-12-29 20:01:55 +00:00
Fred Drake b0744c5a28 Make "{" and "}" in code sample visible instead of a group (it's supposed to
be a dictionary...).
1997-12-29 19:59:38 +00:00
Fred Drake bef9b0b039 Added missing "\" to "\var{address}, var{length}" in buffer_info() description. 1997-12-29 19:33:45 +00:00
Fred Drake 6884e3b94b Reduce warning count from partparse.py. 1997-12-29 19:09:37 +00:00
Fred Drake c416445d7e Use tableii environment for the table instead of tabular. This makes it
consistent with other 2-column tables in the Python documentation.
1997-12-29 19:02:01 +00:00
Fred Drake 671fe9dd31 Reduce warning count from partparse.py. 1997-12-29 18:53:31 +00:00
Fred Drake a3e672b574 Nit adjustments to remove warnings when processed with partparse.py. 1997-12-29 18:21:37 +00:00