Commit graph

3156 commits

Author SHA1 Message Date
Fred Drake
31f5550fbe Thomas Wouters <thomas@xs4all.net>:
Reference manual docs for augmented assignment.

This closes SourceForge patch #101418.
2000-09-12 20:32:18 +00:00
Fred Drake
7740a01096 Thomas Wouters <thomas@xs4all.net>:
Fix up some of the PyNumber_*() documentation.
Add documentation for the InPlace API calls.
2000-09-12 20:27:05 +00:00
Fred Drake
f913e542be Vladimir Marangozov <Vladimir.Marangozov@inrialpes.fr>:
Here are some changes to the C API docs. The memory examples & API have
been updated because one malloc family is gone (Py_Malloc).
You'll see other small additions to the "building new types" section
for completeness and some cleanup at the end of the memory section.
2000-09-12 20:17:17 +00:00
Fred Drake
c56817353d Re-wrapped some wide comments.
Fixed Module Index generation.
2000-09-12 20:13:04 +00:00
Fred Drake
b7cf378023 Add note that the various \see* macros are only defined in the context
of a seealso environment.
2000-09-12 19:58:10 +00:00
Fred Drake
5dc6104729 Change the title of the link to the document index to be more specific. 2000-09-12 19:53:18 +00:00
Fred Drake
ae86d43f11 Add a reference item pointing to the Namespaces in XML recommendation.
Convert the existing reference items to \seetitle markup.
2000-09-12 17:53:48 +00:00
Fred Drake
48449985f4 \seetitle: New macro for building reference list content. 2000-09-12 17:52:33 +00:00
Fred Drake
1349437e4c When referring to namespaces, always say "namespaces" instead of
"name spaces".

Inconsistency noted by Keith Briggs <keith.briggs@bt.com>.
2000-09-12 16:23:48 +00:00
Fred Drake
81cccb7563 Added documentation for PySequence_Fast() and PySequence_Fast_GET_ITEM(). 2000-09-12 15:22:05 +00:00
Fred Drake
aafc0c4595 When formatting the API manual, use the generated api.tex rather than
the original, since the refcount information has been added there.
2000-09-12 15:20:54 +00:00
Skip Montanaro
b655939d69 add index entries for list comprehensions 2000-09-11 16:31:55 +00:00
Fred Drake
88fa9627b1 Some updates and fix a bunch of really small consistency nits. 2000-09-11 05:23:25 +00:00
Fred Drake
08c5d0cdcb Add documentation for the \pep and \seepep macros. 2000-09-11 05:22:30 +00:00
Greg Ward
14deaaec12 Minor tweaks to get rid of some '\XXX' remarks. 2000-09-11 00:33:15 +00:00
Fred Drake
643d76d735 Add support for new \pep, \seepep, excclassdesc markup.
Update processing of module synopsis tables (found at the beginning of
most chapters of the library reference) to reflect changes in the
processing pattern of recent versions LaTeX2HMTL.  Requires most
recent change to SynopsisTable.pm.

This does not fix the module index problem.
2000-09-09 06:07:37 +00:00
Fred Drake
4e607964d1 excclassdesc: New environment. For use in documenting class-based
exceptions which have interesting constructor signatures.

\pep, \seepep:  New macros.  Equivalent to \rfc and \seerfc, but
        referring to the PEP series instead of the Internet RFC
        series of documents.
2000-09-09 06:01:25 +00:00
Fred Drake
75c6cb909c Add support for a filename to record the name of the node in which the
table will be presented.  Accessor methods are used to access the
attribute.
2000-09-09 05:53:41 +00:00
Fred Drake
1b194f927d Add a reference to the material on string methods. 2000-09-09 05:34:06 +00:00
Fred Drake
f96e0d203b Various clarifications and minor nits fixed. Affected descriptions of
input(), locals(), reload(), unicode(), and zip().
2000-09-09 03:33:42 +00:00
Fred Drake
1172a85175 Really minor consistency nit. 2000-09-09 03:31:17 +00:00
Fred Drake
66571cc20c Improve a couple of references to the language reference, making them
hyperlinks to relevant sections.

Clarify the conditions under which the "softspace" attribute of file-like
objects can "just work" (with relation to overriding of attribute access
in user-defined classes).
2000-09-09 03:30:34 +00:00
Fred Drake
7acb21866c Minor clarifications in the introductory paragraph. 2000-09-09 03:28:00 +00:00
Fred Drake
e544191397 Add \modulesynopsis for inclusion in the list of modules at the beginning
of the chapter.

Add explanation that this is only available when the cycle detector is
enabled at build time.
2000-09-09 03:26:51 +00:00
Fred Drake
1c4efad770 Move the "See also" section to a location more consistent with other
module sections.  Properly mark the name of the module in the content
of the reference there.
2000-09-09 03:25:11 +00:00
Fred Drake
621d2bee1c Move description of UserString.MutableString to a location more typical
of the arrangement of other modules.
2000-09-09 03:23:50 +00:00
Fred Drake
1c25803647 Add a brief section on linking Python as an embedded scripting language.
This closes SourceForge bug #110833.
2000-09-08 22:54:53 +00:00
Fred Drake
90f876798f When building the HTML packages, make sure we pick up all the HTML files
at the top level of the tree.
2000-09-08 21:54:44 +00:00
Fred Drake
a61bfa84c9 Add a general "About" page and link to it from the index page.
This fixes SourceForge bug #113810.
2000-09-08 21:53:22 +00:00
Fred Drake
6c8affe590 Remove an item that no longer needs to be done for 2.0. 2000-09-07 21:11:45 +00:00
Fred Drake
ae3a15c396 Make the HTML more XHTML-friendly.
Small nits in the layout of the generated markup.
2000-09-07 20:07:41 +00:00
Fred Drake
31edf4defb Wrap some long lines.
Note that \file and \filenq do not work inside section titles.
2000-09-07 20:06:07 +00:00
Fred Drake
5cd0cefbd2 Remove the specific date -- back in development mode. 2000-09-07 18:56:29 +00:00
Fred Drake
d0726c3cd9 \file is not allowed in section titles -- converting to PDF fails due to
weird macro-expansion issues.  A better solution may be available in the
future, but this will do for now.

Add an index entry.  More should probably be added as well.
2000-09-07 18:55:08 +00:00
Fred Drake
88c023b863 Remove comment about -X and string exceptions. Error noted by
Justin D. Pettit <jpettit@raznick.com>.
2000-09-07 16:33:32 +00:00
Fred Drake
6300bd42a4 Added note about Python version this was added for. 2000-09-07 14:01:40 +00:00
Fred Drake
77a6c9ece5 Minor markup nits around use of \optional. 2000-09-07 14:00:51 +00:00
Greg Ward
b652897456 Greatly enhanced the section on creating built distributions; in
particular wrote up creating RPMs in detail.
Other scattered improvements.
2000-09-07 02:40:37 +00:00
Andrew M. Kuchling
4d46d38292 Add new section "What About Python 1.6?"
Document some things in the 2.0 NEWS files that should be mentioned here.
2000-09-06 17:58:49 +00:00
Andrew M. Kuchling
d500e44297 Removed mention of the winreg module, since it was deleted from 2.0b1 2000-09-06 12:30:25 +00:00
Fred Drake
8b2e8f846c Added a \versionadded statement to the getfqdn() description. 2000-09-06 02:22:16 +00:00
Greg Ward
54589d4d97 General overhaul of the "Creating a Source Distribution" section --
better explanation of manifest files, in particular.
2000-09-06 01:37:35 +00:00
Fred Drake
239e1d5e50 Fix mkhowto so that the bookmarks for the PDF work for both "howto" and
"manual" class documents.
2000-09-05 21:45:11 +00:00
Fred Drake
8bdf0bf705 Fix PDF generation.
The \\ introduced in the \author in boilerplate.tex broke the PDF
generation because line breaks are not allowed in the "Document Info"
metadata stored in the PDF file.  This changes the line break to
a ", " (comma-space) in that context.
2000-09-05 15:19:56 +00:00
Fred Drake
82de71dae8 Minor nit to make this work a little better with the PDF generation fix.
This does not change the HTML or PostScript output.
2000-09-05 15:11:56 +00:00
Fred Drake
8ff4cd7512 Minor markup revisions for consistency with the rest of the documentation. 2000-09-05 13:50:21 +00:00
Fred Drake
0d83f68fc9 Added entry for mmap module. 2000-09-05 13:49:30 +00:00
Fred Drake
c28425f4c6 Update license according to the LICENSE file in the source tree. 2000-09-05 04:32:26 +00:00
Fred Drake
05e4ef01a2 Set the date. 2000-09-05 03:13:38 +00:00
Greg Ward
47f99a6174 Fleshed out the section on the setup config file, setup.cfg.
Added a few clarifying footnotes and cross-references.
Various minor tweaks.
2000-09-04 20:07:15 +00:00