Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity
21,589 Commits 7 Branches 587 Tags 2.3 GiB
Commit Graph

59 Commits

Author SHA1 Message Date
Fred Drake d6bdb075ca Update the list of output formats. 2002-01-17 12:35:20 +00:00
Fred Drake 6ca33771f8 Add a new environment for whole-paragraph (or longer) notes & warnings. 2001-12-14 22:50:06 +00:00
Fred Drake 5ed35fd149 Add a new environment in the Python docs markup: seealso*. This is similar 
to seealso, but does not add the "See also:" header or put the content in a
box in the HTML version.

Updated the description of \seeurl to better indicate when it should be used;
the old description was written before we had \seetitle.
 2001-11-30 18:09:54 +00:00
Fred Drake 64a5aaf05c Describe the content given as the parameter to the \note and \warning macros 
in more detail, and use them where appropriate.
 2001-10-20 04:18:14 +00:00
Fred Drake 92350b3a1f New markup: \note{...} and \warning{...} 2001-10-09 18:01:23 +00:00
Fred Drake 203d91a461 Note that the colon following a mail header name should not be included 
when using the \mailheader markup.
Change a couple of inline examples to show the markup rather than the
result.
 2001-09-26 18:43:20 +00:00
Fred Drake 8b3a7b58b9 Move the \mailheader description to the right place. 
Clarify the \mimetype description; it can be used to refer to a part of a
MIME type name, so \mimetype{text} or \mimetype{plain} can be used, not
just \mimetype{text/plain}.
 2001-09-26 17:01:58 +00:00
Fred Drake f9dc04341d Fix a minor markup typo. 2001-08-29 02:34:10 +00:00
Fred Drake b5f17f2dc5 Revise comments about TeX & LaTeX for accuracy. 
This closes SF bug #456222.
 2001-08-28 18:09:11 +00:00
Fred Drake 0cac5f697b Added some examples of table markup. 2001-08-14 21:36:19 +00:00
Fred Drake 7eac0cb04c Define the \mailheader macro and document conventions for using it. 2001-08-03 18:36:17 +00:00
Fred Drake f1b3de8d5c Add labels to all \section and \subsection headings for use in references. 2001-07-24 14:38:34 +00:00
Fred Drake f269e59232 Define new markup for 5-column tables. 2001-07-17 23:05:57 +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 07178d237a For \kbd, be more prescriptive regarding how keystrokes should be 
written.
 2001-07-12 02:08:29 +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 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 66eed24415 Add some information on the use of \verbatiminput to display sources from 
an external file.
 2001-06-18 14:59:58 +00:00
Fred Drake 9f2376de7a Document the new classdesc* environment, and the previously undocumented 
excclassdesc environment.
 2001-05-11 01:01:12 +00:00
Fred Drake 3151f44d49 Add description of the "explanation" optional parameter added to the 
\versionadded macro.

Note: this should not be merged into the 2.1 maintenance branch.
 2001-04-18 05:19:06 +00:00
Fred Drake 4c6f17a537 Make a number of small clarifications and correct a whole bunch of typos, 
all reported by Bruce Smith.
 2001-04-18 05:12:47 +00:00
Fred Drake 2bbc6974d0 Fix a number of small issues; this closes SF bug #411063. 2001-03-28 16:51:20 +00:00
Fred Drake b7a52c9de3 Minor typo: \subsubsections --> \subsubsection 2000-11-27 20:10:18 +00:00
Fred Drake 8fdb6383dc Update author information. 2000-10-28 04:08:38 +00:00
Fred Drake d097d48200 Flesh out the "LaTeX Primer" some more. 2000-10-20 20:51:31 +00:00
Fred Drake 63568aa9bb Revise the capitalization policy of \versionchanged explanation; the 
explanation must now be capitalized.  This is more consistent with the
\see* explanation fields.

Added a lot of material to the "LaTeX Primer" section.
 2000-10-19 05:36:10 +00:00
Fred Drake da72b93a01 Add new environments: longtableii, longtableiii, and longtableiv, to 
support long tables which might break across page boundaries.  Otherwise
identical to tableii, tableiii, and tableiv.
 2000-09-21 15:58:02 +00:00
Fred Drake 02997491c1 Document directories are not always named with three characters any more; 
reported by Detlef Lannert <lannert@uni-duesseldorf.de>.
 2000-09-21 05:26:43 +00:00
Fred Drake 7be440da1a Document \cfuncdesc, \ctypedesc, and \cvardesc. 2000-09-16 21:23:25 +00:00
Fred Drake 6a547c7878 Fix a link -- there is no starship.python.org! 2000-09-15 22:11:24 +00:00
Fred Drake af2b71466a \shortversion, 
\setshortversion:  New markup to help deal with Python having a "real"
                   version number and an abbreviated version number
                   used to create pathnames to the library installation.
 2000-09-14 20:11:05 +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 48449985f4 \seetitle: New macro for building reference list content. 2000-09-12 17:52:33 +00:00
Fred Drake 08c5d0cdcb Add documentation for the \pep and \seepep macros. 2000-09-11 05:22:30 +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 7932ed0ac4 Added material about documenting packages, so that the use of module 
markup for packages is clear.
 2000-08-11 17:37:33 +00:00
Fred Drake 1cb3a9ecef Add entries for the distutils documents to the directories table. 2000-07-25 19:27:17 +00:00
Fred Drake 5802e48033 Added some further description to the usage of the seealso environment. 
Documented the \seerfc and \seeurl macros used in that environment as well.
 2000-07-06 05:24:41 +00:00
Fred Drake 633a8d90d5 Update authors email address and corporate affiliation. 2000-06-30 15:54:18 +00:00
Fred Drake c26cc91c0c Added descriptions of \versionadded and \versionchanged. 2000-05-02 17:43:44 +00:00
Fred Drake 2b85341776 Elaborate descriptions of \e, \module. 
Describe policy on vertical lines in tables.
 2000-04-11 19:08:30 +00:00
Fred Drake ce44498ba8 Revise the description of \programopt, document \longprogramopt. 2000-04-11 18:52:52 +00:00
Fred Drake 42934689ea Note that "Unicode" is always capitalized. 2000-04-03 15:00:28 +00:00
Fred Drake e15956b465 Merged changes from the 1.5.2p2 release. 2000-04-03 04:51:13 +00:00
Fred Drake 29a710f2ef Document \citetitle and \programopt. 1999-11-10 22:51:18 +00:00
Fred Drake 698d5206aa Use \citetitle in several places. 1999-11-10 15:54:57 +00:00
Fred Drake d290c10890 Use \programopt in one place. 1999-11-09 18:03:00 +00:00
Fred Drake 5eb992beed Last night's scribbles: 
- Revise abstract based on Guido's comments from way back.
- Point out that LaTeX is a structured system & we're using it that
  way.
- Add a small section on marking up code examples.
 1999-06-11 14:25:45 +00:00
Fred Drake d2a727feee Hack: make sure LaTeX2HTML doesn't change -- to - in mkhowto 
description.
 1999-05-27 21:45:54 +00:00
Fred Drake d1fb77970d Document \e, \url. 
Add a few more comments about mkhowto.

Based on comments from Albert <hat@se-46.wpa.wtb.tue.nl>.
 1999-05-17 16:33:54 +00:00