Commit d1e7270d authored by Fred Drake's avatar Fred Drake

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.
parent 0920ee72
...@@ -462,8 +462,6 @@ This \UNIX\ is also followed by a space. ...@@ -462,8 +462,6 @@ This \UNIX\ is also followed by a space.
broader. This class is used for ``how-to'' documents (this broader. This class is used for ``how-to'' documents (this
document is an example) and for shorter reference manuals for small, document is an example) and for shorter reference manuals for small,
fairly cohesive module libraries. Examples of the later use include fairly cohesive module libraries. Examples of the later use include
the standard \citetitle[../mac/mac.html]{Macintosh Library Modules}
and
\citetitle[http://starship.python.net/crew/fdrake/manuals/krb5py/krb5py.html]{Using \citetitle[http://starship.python.net/crew/fdrake/manuals/krb5py/krb5py.html]{Using
Kerberos from Python}, which contains reference material for an Kerberos from Python}, which contains reference material for an
extension package. These documents are roughly equivalent to a extension package. These documents are roughly equivalent to a
...@@ -824,7 +822,9 @@ This \UNIX\ is also followed by a space. ...@@ -824,7 +822,9 @@ This \UNIX\ is also followed by a space.
specifications. The header name should be entered in the same specifications. The header name should be entered in the same
way it would normally be found in practice, with the way it would normally be found in practice, with the
camel-casing conventions being preferred where there is more camel-casing conventions being preferred where there is more
than one common usage. For example: \mailheader{Content-Type}. than one common usage. The colon which follows the name of the
header should not be included.
For example: \code{\e mailheader\{Content-Type\}}.
\end{macrodesc} \end{macrodesc}
\begin{macrodesc}{makevar}{\p{name}} \begin{macrodesc}{makevar}{\p{name}}
...@@ -870,7 +870,7 @@ This \UNIX\ is also followed by a space. ...@@ -870,7 +870,7 @@ This \UNIX\ is also followed by a space.
The symbol for indicating a value that may take a positive or The symbol for indicating a value that may take a positive or
negative value of a specified magnitude, typically represented negative value of a specified magnitude, typically represented
by a plus sign placed over a minus sign. For example: by a plus sign placed over a minus sign. For example:
\emph{The lateral movement has a tolerance of \plusminus 3\%{}}. \code{\e plusminus 3\%{}}.
\end{macrodesc} \end{macrodesc}
\begin{macrodesc}{program}{\p{name}} \begin{macrodesc}{program}{\p{name}}
...@@ -1012,7 +1012,7 @@ This \UNIX\ is also followed by a space. ...@@ -1012,7 +1012,7 @@ This \UNIX\ is also followed by a space.
modules. The name for a module in a package should be typed in modules. The name for a module in a package should be typed in
``fully qualified'' form (it should include the package name). ``fully qualified'' form (it should include the package name).
For example, a module ``foo'' in package ``bar'' should be marked as For example, a module ``foo'' in package ``bar'' should be marked as
\samp{\e module\{bar.foo\}}, and the beginning of the reference \code{\e module\{bar.foo\}}, and the beginning of the reference
section would appear as: section would appear as:
\begin{verbatim} \begin{verbatim}
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment