Commit Graph

4065 Commits

Author SHA1 Message Date
Fred Drake 68db730324 Adding what's done of the documentation for the new profiling &
tracing interface.  Incomplete, but better to check it in since I've
been including it in my updates.
2001-07-17 19:48:30 +00:00
Andrew M. Kuchling c32cc7c11d Delete sentence fragment (noted by Fred Bremmer) 2001-07-17 18:25:01 +00:00
Fred Drake 1385a57b85 Bump the release number.
Make the syntax of compound command lines more portable (nmake, CygWin).
These changes are an adaptation of SF patch #429611.

Use the new tools/rewrite.py instead of grep/date/sed to transform
html/index.html.in into html/index.html; this is required for portability.
2001-07-17 16:53:19 +00:00
Fred Drake 16649a803b Make the syntax for compound command lines more portable (nmake, CygWin).
This is probably not sufficient by itself for the info generation, and is
being done mostly to keep the style consistent with additional patches
that will be applied to Doc/Makefile.
2001-07-17 16:48:55 +00:00
Fred Drake 3cae66bdbc Script to re-write @FOO@-style marks with values, initializing the
replacement for @DATE@ from a TeX file containing a \date{...} mark
(such as texinputs/boilerplate.tex).

This will be used to re-write the html/index.html.in file instead of
a combination of grep, date, and sed -- this is more portable to non-Unix
platforms.

This solves part of the problem reported in SF patch #429611, but does
not use the suggested patch.
2001-07-17 16:46:14 +00:00
Fred Drake 63d1d264d1 Update the release information. 2001-07-17 16:28:50 +00:00
Fred Drake f8a17b14c4 Now we're picking nits: get my name right! ;-) 2001-07-17 14:54:07 +00:00
Andrew M. Kuchling 6ea9f0bb20 Add FLD to credit list
Correct grammatical error
2001-07-17 14:50:31 +00:00
Fred Drake aebbca3b61 Job.__init__(): Only create the builddir directory if it will be used (by
building the HTML or text documentation).  There is no need to create
    it for other formats.

Job.build_html():  The builddir parameter is always passed in, so it need
    not be optional.
2001-07-17 14:46:09 +00:00
Fred Drake 0d00254cc1 Cleaned up a number of minor nits, use markup a little more consistently. 2001-07-17 13:55:33 +00:00
Andrew M. Kuchling 4cf52a9a80 Minor rewrites to iterator and generator sections
Credit both Neil and Tim for generators
Fix indentation of a few paragraphs
2001-07-17 12:48:48 +00:00
Fred Drake e78661bf90 Fix a couple of minor markup nits.
Footnotes should be added *after* punctuation, not before.
(Yes, this should be merged with the descr branch.  Sorry, Tim!)
2001-07-17 05:17:58 +00:00
Barry Warsaw 95400a28e4 Updated the documentation in several respects:
- This module, despite its name, now should conform to RFC 2822, the
  update to RFC 822.

- This module doesn't just represent "email headers", but entire email
  messages.

- Added documentation for other useful public functions such as
  quote(), unquote(), praseaddr(), and dump_address_pair().
2001-07-16 20:47:58 +00:00
Fred Drake 687a17deaa Revise the description of time.clock() so that it correctly describes the
Windows version of the function as well as the Unix flavor.

This fixes SF bug #441357.
2001-07-16 15:40:57 +00:00
Andrew M. Kuchling ddeb1358a4 Use \longprogramopt, as suggested by FLD 2001-07-16 14:35:52 +00:00
Andrew M. Kuchling ced2366a05 Use \verb for configure switches, because inside \code multiple dashes
are merged to a single hyphen.
Delete forgotten CVS conflict marker
2001-07-16 13:45:31 +00:00
Andrew M. Kuchling 2cd712b812 Write some entries in the "Other changes" section
Write description of .encode()/.decode for the Unicode section
Bump version number
2001-07-16 13:39:08 +00:00
Andrew M. Kuchling 4dbf87152e Began actually writing:
* iterators
* generators
* copied the nested scopes section from the 2.1 article
* standard library changes
2001-07-16 02:17:14 +00:00
Fred Drake 44845ba67d Change the target name for \kbd. 2001-07-14 03:10:20 +00:00
Fred Drake 9725fd8c26 Add another name. 2001-07-14 03:09:29 +00:00
Fred Drake 755c23dcc4 Oops, one more caret. 2001-07-14 03:05:53 +00:00
Fred Drake 377fb1e1f6 Fix the markup of the caret charater in a couple of places; LaTeX's
special character bite us again.  ;-(

This fixes SF bug #440911.
2001-07-14 03:01:48 +00:00
Fred Drake 8ee679f0ce Minor changes to match the style guide. 2001-07-14 02:50:55 +00:00
Fred Drake 4124a0b343 Correct a couple of errors noted by Alex Martelli. 2001-07-14 02:46:01 +00:00
Fred Drake 7fc8abb396 Remove comments about XML and HTML; those sections are no
longer part of this chapter.

Minor change to match the style guide.
2001-07-14 02:44:43 +00:00
Fred Drake 9120df388c Add a little more information about the usage of some terms where the
style guide can use a little clarification, and present some minor
specific markup.

Make a few adjustments to conform to the style guide.
2001-07-14 02:34:12 +00:00
Fred Drake 7a889ceb1e Minor change to match the style guide. 2001-07-14 02:27:22 +00:00
Fred Drake 17f690f96b Minor changes to match the style guide. 2001-07-14 02:14:42 +00:00
Fred Drake 6e5e1d924c Minor change to match the style guide. 2001-07-14 02:12:27 +00:00
Fred Drake 8da359bdc0 Minor changes to match the style guide.
Make the reference to the python-docs email address a hyperlink; we want to
encourage responses to the plea for help!
2001-07-14 02:09:32 +00:00
Fred Drake 3d97e35a20 Add entry for xmlrpclib documentation. 2001-07-12 23:40:13 +00:00
Fred Drake 5ddf7adf84 Several markup adjustments so this will format and be more consistent with
the rest of the documnentation.
2001-07-12 23:39:24 +00:00
Fred Drake 602cf584be Generate a more meaningful message regarding the type of the documentation
release being discussed.
2001-07-12 21:50:10 +00:00
Fred Drake f4bdb57e15 Fix return value for m.group() for groups not in the part of the RE that
matched; reported by Paul Moore.

Wrapped several long lines.
2001-07-12 14:13:43 +00:00
Guido van Rossum bf5a774bcb On int/long to the negative int/long power, let float handle it
instead of raising an error.  This was one of the two issues that the
VPython folks were particularly problematic for their students.  (The
other one was integer division...)  This implements (my) SF patch
#440487.
2001-07-12 11:27:16 +00:00
Eric S. Raymond e304bb9eec First version of xmlrpclib docs. Probably has markup errors; is not complete,
could probably stand to have some of the internal things like Marshaller
documented.  But I think it does a decent job on the entry points and
externally visible things.

Fred and Fredrik, do your stuff!  You both need to proof this.
2001-07-12 02:39:45 +00:00
Fred Drake 682d5f3cda Follow the recommended practices for keystroke representation; this
improves internal consistency in the documentation.
2001-07-12 02:09:51 +00:00
Fred Drake 07178d237a For \kbd, be more prescriptive regarding how keystrokes should be
written.
2001-07-12 02:08:29 +00:00
Fred Drake fa774872b8 Move the section on concrete numeric objects before the section on
concrete sequence objects, since their API is simpler.

This is in response to a comment in SF bug #440037.
2001-07-11 20:35:37 +00:00
Andrew M. Kuchling 7bf8277e98 Note addition of xmlrpclib
Comment out descr-branch section
Update e-mail address
    (Time to begin writing this...)
2001-07-11 18:54:26 +00:00
Fred Drake 9bbc933fcb Added information about the timeout parameter to the poll() method for
polling objects.  This closes SF bug #439823.

Fixed a minor markup bug.
2001-07-11 18:48:39 +00:00
Fred Drake d854831ddd Corrected the refcount information for PyList_SET_ITEM(). 2001-07-10 16:19:13 +00:00
Fred Drake bab2965c7c Document PyObject_New(), PyObject_NewVar(), PyObject_Init(),
PyObject_InitVar(), PyObject_Del(), PyObject_NEW(),
PyObject_NEW_VAR(), and PyObject_DEL().

Add notes to PyMem_Malloc() and PyMem_New() about the memory buffers
not being initialized.

This fixes SF bug #439012.


Added explicit return value information for PyList_SetItem(),
PyDict_SetItem(), and PyDict_SetItemString().  Corrected return type
for PyList_SET_ITEM().

Fixed index entries in the descriptions of PyLong_AsLong() and
PyLong_AsUnignedLong().

This fixes the API manual portion of SF bug #440037.


Note that the headers properly declare everything as 'extern "C"' for
C++ users.

Document _Py_NoneStruct.

Added links to the Extending & Embedding manual for PyArg_ParseTuple()
and PyArg_ParseTupleAndKeywords().

Added note that PyArg_Parse() should not be used in new code.

Fix up a few style nits -- avoid "e.g." and "i.e." -- these make
translation more difficult, as well as reading the English more
difficult for non-native speakers.
2001-07-10 16:10:08 +00:00
Fred Drake 12060e5ed3 Added descriptions for some modules that previously did not have any
information about them, based on comments from Jack Jansen.
2001-07-10 14:19:45 +00:00
Fred Drake 67f193faab Add a little bit more about the XML migration plan. This still needs a lot
of work, but mostly it needs time spent doing the work to make the
generated XML useful.
2001-07-09 16:04:03 +00:00
Fred Drake 03e88da81b Add conversion information for the grammar production support (preliminary). 2001-07-09 15:00:42 +00:00
Thomas Wouters e30ac57038 Fix for SF bug #436525, reported by Greg Kochanski:
The block/unblock thread macros are called 'Py_BLOCK_THREADS' and
'Py_UNBLOCK_THREADS', not 'Py_BEGIN_BLOCK_THREADS' and
'Py_BEGIN_UNBLOCK_THREADS'.
2001-07-09 14:35:01 +00:00
Fred Drake 44835d8e7a Move & update a comment.
Add support for the \ulink macro.
2001-07-07 06:00:36 +00:00
Fred Drake de6dc1e11c Change the way notification mails are sent so people who respond to the
update announcements do not get bounces from trying to send mail to my
laptop, which has an identity crisis due to constant relocation.
2001-07-06 23:45:16 +00:00
Fred Drake 8e0c09da62 More reference count information. 2001-07-06 23:31:49 +00:00
Fred Drake cb4638a278 Change the grammar productions to use the new productionlist environment;
this supports a hyperlinked version of the grammar that can make tracking
down details and definitions a little easier.
2001-07-06 22:49:53 +00:00
Fred Drake b2d1006272 Update the description of how to start an interpreter and determine the
installation prefix and exec_prefix for Windows.
2001-07-06 22:46:52 +00:00
Fred Drake b4b64daa5e Add \ulink, grammar production markup. 2001-07-06 22:44:48 +00:00
Fred Drake 77602f2e32 Add support for \ulink and hyperlink grammars.
do_cmd_verbatiminput():  Write out a text file containing the content of the
    input file with a .txt extension, and add a link to it at the bottom of
    the presentation.  This easier retrieval of example source code for
    copy & paste use.
2001-07-06 22:43:02 +00:00
Fred Drake bde8d1c8af Revise a comment about styles I don't think LaTeX2HTML can generate,
but which came from their default stylesheet.

Add styles for the new hyperlinked grammar productions.
2001-07-06 22:37:36 +00:00
Fred Drake 432cef0d0b Add new material on some markup that will be checked in shortly. This
includes some minor new inline markup and markup to generate hyperlinked
grammar productions.

Adopt a "style guide" document -- this beats writing our own and means
we'll have a chance at consistency, without having to make it all up
ourselves.
2001-07-06 22:34:33 +00:00
Fred Drake 238858fc51 Packaged versions of the HTML format need to include any .txt files that
were generated by the use of the productionlist environment or the
\verbatiminput macro.
2001-07-06 22:28:47 +00:00
Fred Drake 7e79b9e1cc More names, yay! 2001-07-06 22:27:04 +00:00
Fred Drake 0a650d77d5 Add entries for recently defined markup. 2001-07-06 21:13:51 +00:00
Fred Drake dde993c15d Simplification to mirror a better conversion specification and more
powerful latex2esis.py.
2001-07-06 21:03:30 +00:00
Fred Drake b5fc0ab099 Allow optional arguments to LaTeX macros to span lines. This is legal in
LaTeX and we have at least one occurance of that in the content, so this
script needs to support it as well.
2001-07-06 21:01:19 +00:00
Fred Drake 907e76b620 Fix up a few style nits -- avoid "e.g." and "i.e." -- these make
translation more difficult, as well as reading the English more
difficult for non-native speakers.
2001-07-06 20:30:11 +00:00
Fred Drake ab1df4fe88 Fix up a few style nits -- avoid "e.g." and "i.e." -- these make
translation more difficult, as well as reading the English more
difficult for non-native speakers.

Add an index entry for the Telnet protocol.

Always refer to the protocol as Telnet instead of telnet.
2001-07-06 20:23:02 +00:00
Fred Drake 91f2f26d75 Fix up a few style nits -- avoid "e.g." and "i.e." -- these make
translation more difficult, as well as reading the English more
difficult for non-native speakers.
2001-07-06 19:28:48 +00:00
Fred Drake ed51494666 Fix up a few style nits -- avoid "e.g." and "i.e." -- these make
translation more difficult, as well as reading the English more
difficult for non-native speakers.
2001-07-06 17:28:39 +00:00
Fred Drake 45c23e61d8 Explain the exit code for the wait() method, including a reference to
the os.W*() functions used to interpret the return value.

This fixes SF bug #429361.
2001-07-06 17:17:12 +00:00
Fred Drake 15e33d828c Fix up a few style nits -- avoid "e.g." and "i.e." -- these make
translation more difficult, as well as reading the English more
difficult for non-native speakers.
2001-07-06 06:49:32 +00:00
Fred Drake bcd1df746d The fpectl module does not work on Windows, so remove Windows from the
\platform statement.

Also fix a minor style consistency nit in an example.
2001-07-05 21:17:08 +00:00
Fred Drake a939911345 Fix a markup error: do not omit a method's parameter list if it is
empty.
2001-07-05 21:14:03 +00:00
Fred Drake 25211f5724 Added more information on the differences between the htmllib and HTMLParser
modules.
2001-07-05 16:34:36 +00:00
Guido van Rossum 5fe2c139d5 List constraints on xrange() objects. 2001-07-05 15:27:19 +00:00
Guido van Rossum 3f56166b1a Rip out the fancy behaviors of xrange that nobody uses: repeat, slice,
contains, tolist(), and the start/stop/step attributes.  This includes
removing the 4th ('repeat') argument to PyRange_New().
2001-07-05 13:27:48 +00:00
Fred Drake 20006b2d51 Marked the parameters to Stats.print_*() as optional.
This closes SF bug #438032.
2001-07-02 21:22:39 +00:00
Fred Drake cb9be93955 Add another name. 2001-07-02 17:16:07 +00:00
Tim Peters 4efb6e9643 Turns out Neil didn't intend for *all* of his gen-branch work to get
committed.

tokenize.py:  I like these changes, and have tested them extensively
without even realizing it, so I just updated the docstring and the docs.

tabnanny.py:  Also liked this, but did a little code fiddling.  I should
really rewrite this to *exploit* generators, but that's near the bottom
of my effort/benefit scale so doubt I'll get to it anytime soon (it
would be most useful as a non-trivial example of ideal use of generators;
but test_generators.py has already grown plenty of food-for-thought
examples).

inspect.py:  I'm sure Ping intended for this to continue running even
under 1.5.2, so I reverted this to the last pre-gen-branch version.  The
"bugfix" I checked in in-between was actually repairing a bug *introduced*
by the conversion to generators, so it's OK that the reverted version
doesn't reflect that checkin.
2001-06-29 23:51:08 +00:00
Fred Drake 88e66254f9 Use the more conventional "self" as the name of the self parameter in an
example.  It actually confused a reader.
2001-06-29 17:50:57 +00:00
Fred Drake 0c209047ba Correct a markup error for an accented character.
Reported by Milan Zamazal <pdm@zamazal.org>.
2001-06-29 16:25:07 +00:00
Fred Drake 58c95391fa Removed some stray periods, and fix up a number of visible markup
consistency errors (mostly omitted "()" at the end of function and
method names).

Reported by Milan Zamazal <pdm@zamazal.org>.
2001-06-29 16:21:47 +00:00
Fred Drake 9c3c5e406d Two more names. 2001-06-29 15:42:20 +00:00
Fred Drake f29ca18df3 SourceForge bug #437041:
Use a portable format in the example that creates a timestamp suitable for
use in email, also updating it and the footnote from RFC 822 to RFC 2822.
2001-06-29 15:39:53 +00:00
Fred Drake 9f9bd6af78 Simplify an example based on comment from Thomas Holenstein <thomas@hex.ch>:
Do not use an extra flag variable to test only once in one subsequent if
statement.
2001-06-29 14:59:01 +00:00
Andrew M. Kuchling a43e70396e Add more items that need to be written about 2001-06-27 20:32:12 +00:00
Thomas Wouters 69940973db Remove duplicate ', ' in dbhash.open()'s argument list. 2001-06-27 13:49:59 +00:00
Barry Warsaw e9218a1a8e Remove the restriction on a mapping's .update() method. 2001-06-26 20:32:59 +00:00
Tim Peters 3e7b1a04a0 Teach the types module about generators. Thanks to James Althoff on the
Iterators list for bringing it up!
2001-06-25 19:46:25 +00:00
Fred Drake b037d33245 Updated link to zlib's home page. 2001-06-25 15:30:13 +00:00
Andrew M. Kuchling e7e03cd0cf Fix typo 2001-06-23 16:26:44 +00:00
Eric S. Raymond ff00fdae23 Correct erroneous description of precmd. 2001-06-23 14:42:43 +00:00
Fred Drake be9d10edbb Remove some bogus trailing whitespace. 2001-06-23 06:16:52 +00:00
Fred Drake 93852ef3c8 Fix minor markup nits. 2001-06-23 06:06:52 +00:00
Fred Drake deda9f3420 Use a named reference to another chapter instead of hard coding the
chapter number.  This also makes the reference a hyperlink in the HTML
version.
2001-06-23 06:06:21 +00:00
Fred Drake 2829f1cf99 Fix a very minor (but annoying when looking for things!) markup nit. 2001-06-23 05:27:20 +00:00
Fred Drake f5eae668a8 Add "yeild" to the list of keywords.
Fix a very minor (but annoying when looking for things!) markup nit.
2001-06-23 05:26:52 +00:00
Fred Drake 1ab1f71ec3 Consistently use semi-colons after the last property for each selector. 2001-06-23 04:53:43 +00:00
Fred Drake f015d9a5f6 Give the pattern used to pick out a source anchor a more specific pattern. 2001-06-23 04:35:09 +00:00
Fred Drake 5962eb0d89 Added several names. 2001-06-23 03:17:02 +00:00
Fred Drake 8058bfa6fc Contributed updates from Harald Hanche-Olsen, giving details of the branch
cuts for the complex math functions.  Includes a brief description of
what branch cuts are.
2001-06-23 03:16:29 +00:00
Fred Drake 6fe4660f61 Added support for our new \infinity and \plusminus macros, and the
standard \textbar macro (not supported in many versions of LaTeX2HTML).

Added newline to error message.
2001-06-23 03:13:30 +00:00
Fred Drake 5445e5e305 \infinity,
\plusminus:  New macros to allow us to avoid math mode for these symbols.
2001-06-23 03:11:45 +00:00
Fred Drake bfd80dd8c0 Miscellaneous code cleanups.
Make sure we do not lose track of the build directory -- convert a user-
supplied directory to an absolute path.
2001-06-23 03:06:01 +00:00