Commit Graph

7311 Commits

Author SHA1 Message Date
Fred Drake 4de05a90be Place C typedef for Py_complex after brief description, to be more consistent
with the other example of a structure description (struct _frozen).

Added index entries for the modules referenced in the document.
1998-02-16 14:25:26 +00:00
Fred Drake 53fb7723ee Added index enties for the Python built-in functions, where appropriate. 1998-02-16 06:23:20 +00:00
Fred Drake e058b4f124 Lots of nitty-gritty stuff:
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.
1998-02-16 06:15:35 +00:00
Fred Drake f1a4150b70 Make sure indexes begin on odd-numbered pages. 1998-02-16 05:30:27 +00:00
Guido van Rossum 36123aae0b Removed condition.py -- it was just sync.py without
the mrsw lock and without 'condition' allocating a lock by default
1998-02-14 03:11:38 +00:00
Guido van Rossum 4d1b3b921d Added DJGPP version of check_case(), by Pit Scrorpion (Hans Nowak).
(BTW, the Mac version was by Jack Jansen.)
1998-02-13 23:27:59 +00:00
Fred Drake b666c15c4a Normalization of markup. 1998-02-13 22:22:36 +00:00
Fred Drake 6e99adb1c9 Don't capitalize identifiers at the beginning of the sentence; re-write to
place them elsewhere so they get the right capitalization.
1998-02-13 22:17:21 +00:00
Fred Drake 01dbb88831 Fix some markup so that the right characters are printed.
"EOF" --> "\EOF{}"
1998-02-13 22:13:07 +00:00
Fred Drake 4a1efb63a9 Capitalize subsection title. 1998-02-13 22:10:21 +00:00
Fred Drake ab875b9a32 Make one paragraph wrap a little better. 1998-02-13 22:07:33 +00:00
Fred Drake a19bb9bbcf Capitalize first word in sentences, use periods at end. 1998-02-13 21:57:33 +00:00
Fred Drake 86b5dcec86 Change {datadesc} environments with empty descriptions to \dataline{}s; this
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.
1998-02-13 21:55:21 +00:00
Fred Drake fc931ecf92 In description of sound_similar(), break up the markup for long
\code{} at each embedded space, so that the words will wrap.  This keeps
it from being too ugly.
1998-02-13 21:49:12 +00:00
Barry Warsaw 2e965add30 __validate(): test for None-age, not not-ness 1998-02-13 21:29:13 +00:00
Barry Warsaw 35ae864ab7 get arrow movement, and text updating. also outlining of highlight 1998-02-13 21:28:47 +00:00
Barry Warsaw 79a7879318 fixed the generators 1998-02-13 21:28:14 +00:00
Barry Warsaw 2662e15f58 triplet_to_pmwrgb(): New function 1998-02-13 21:27:56 +00:00
Fred Drake 315b5d8a7f In description of __import__, second paragraph, break up the markup for long
\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.
1998-02-13 21:26:35 +00:00
Fred Drake 83bd081920 Minor stuff:
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.
1998-02-13 20:59:25 +00:00
Guido van Rossum 0980bd9233 Add case checking feature on import.
This is an option for OS-es with case-insensitive but case-preserving
filesystems.  It is currently supported for Win32 and MacOS.  To
enable it, #define CHECK_IMPORT_CASE in your platform specific
config.h.  It is enabled by default on those systems where it is
supported.  On Win32, it can be disabled at runtime by setting the
environment variable PYTHONCASEOK (to any value).

When enabled, the feature checks that the case of the requested module
name matches that of the filename found in the filesystem, and raises
a NameError exception when they don't match.
1998-02-13 17:18:36 +00:00
Fred Drake 4c6896304b Fix weirdness with single-page table of contents, reported by Guido. 1998-02-13 16:58:49 +00:00
Guido van Rossum e60142f2c1 Adding output of test_xmllib.py 1998-02-13 16:35:21 +00:00
Fred Drake 2549249f79 &do_env_datadescni,
&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.
1998-02-13 15:08:36 +00:00
Fred Drake fb74a463ad Add "Pretty Good Privacy" as well as "PGP" to the index. 1998-02-13 14:52:17 +00:00
Fred Drake c9c456ef69 In add_label_data() description, use "\samp{}" instead of "``\code{...}''"
to indicate the interpreted letters from the format string.
1998-02-13 14:48:00 +00:00
Fred Drake 7f6e2c45ec Use "\samp{...}" instead of "``\code{...}''" when showing markup fragments
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.
1998-02-13 14:38:23 +00:00
Fred Drake b441eb84d3 Use "\samp{...}" instead of "``\code{...}''" when showing markup fragments
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.
1998-02-13 14:37:12 +00:00
Fred Drake aebc6f399e Two new environments: datadescni and funcdescni. These are similar to
datadesc and funcdesc, but don't add entries to the index.
1998-02-13 14:34:04 +00:00
Fred Drake 00dcfb2bc3 &get_indexsubitem: This now has a chance of working, thanks to:
&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.
1998-02-13 07:21:03 +00:00
Fred Drake 8842e867af Remove \bcode / \ecode everywhere.
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.
1998-02-13 07:16:30 +00:00
Fred Drake 1e11a5c117 Remove \bcode / \ecode everywhere.
Make all the indentations in {verbatim} environments have column 0 of the
listing in column 0 of the file.

Remove pagenumbering / pagestyle cruft.
1998-02-13 07:11:32 +00:00
Fred Drake 2a4646c660 Remove obsolete pagenumbering / pagestyle cruft. 1998-02-13 07:08:56 +00:00
Fred Drake 1947991c2f Remove all \bcode / \ecode cruft; this is no longer needed. See previous
checkin of myformat.sty.

Change "\renewcommand{\indexsubitem}{(...)}" to "\setindexsubitem{(...)}"
everywhere.

Some other minor nits that I happened to come across.
1998-02-13 06:58:54 +00:00
Fred Drake dc8af0acc1 Lots of stuff:
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.
1998-02-13 06:48:05 +00:00
Fred Drake cffaebb621 parse_line(): Strip whitespace from the module name.
main():  Include a comma between the module name and page number, to make
	 the generated index more like the "standard" generated index.
1998-02-13 05:11:05 +00:00
Fred Drake fe82acc3b1 Fixed typo in docstring: "__ version__" --> "__version__" 1998-02-13 03:24:48 +00:00
Fred Drake 6eab2fb0f1 Clean up some of the definitions related to info generation. 1998-02-13 03:23:33 +00:00
Guido van Rossum 8a666e7c56 Fix a horrible race condition -- various routines were storing the
most recently opened URL in self.openedurl of the URLopener instance.
This doesn't really work if multiple threads share the same opener
instance!

Fix: openedurl was actually simply the type prefix (e.g. "http:")
followed by the rest of the URL; since the rest of the URL is
available and the type is effectively determined by where you are in
the code, I can reconstruct the full URL easily, e.g. "http:" + url.
1998-02-13 01:39:16 +00:00
Fred Drake e5bc49785c "ASCII" --> "\ASCII{}" 1998-02-12 23:36:49 +00:00
Fred Drake 04cf4dcf58 Added tarpdf target.
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.
1998-02-12 22:33:50 +00:00
Fred Drake e5bf8b2c79 Reorganized a bit. No changed content.
Guido, please take a look at new structure, at least the ToC.
1998-02-12 21:22:28 +00:00
Fred Drake f44617d298 For sections describing the "Foo Protocol", consistently use the capitalized
"Protocol" and not "protocol".
1998-02-12 20:57:15 +00:00
Fred Drake faa1afe2d7 Py_Exit(status) calls exit(status), not exit(0). 1998-02-12 20:51:02 +00:00
Barry Warsaw f7e4793660 fixed initial color 1998-02-12 19:53:01 +00:00
Barry Warsaw 4b0d67d592 typo 1998-02-12 19:52:46 +00:00
Barry Warsaw 29fe4ddd20 Added color strip widgets 1998-02-12 19:52:31 +00:00
Barry Warsaw 9d882bc4de Initial revision 1998-02-12 19:51:57 +00:00
Barry Warsaw f64b4054af (py-compute-indentation): Several changes made to improve navigation
over and around triple-quoted strings:

    - move the beginning-of-line to above the p-p-s call

    - in the `t' clause of the big cond, where we skip over
      triple-quoted strings, first find out if we're looking at a
      single or TQS, then skip over it in one fell swoop, instead of
      trying to loop over skipage of SQS's.

(py-parse-state): Implement XEmacs only hack to more accurately figure
out whether we're in a string or not.  Can't do this in Emacs because
it lacks the necessary primitive, so we just do it the old (and mostly
accurate, but foolable) way for Emacs.
1998-02-12 16:52:14 +00:00
Guido van Rossum da62398139 Correct description of BUILD_SLICE. 1998-02-12 03:53:02 +00:00