Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
C
cpython
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Kirill Smelkov
cpython
Commits
92350b3a
Commit
92350b3a
authored
Oct 09, 2001
by
Fred Drake
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
New markup: \note{...} and \warning{...}
parent
8b78b996
Changes
4
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
with
36 additions
and
0 deletions
+36
-0
Doc/doc/doc.tex
Doc/doc/doc.tex
+17
-0
Doc/perl/python.perl
Doc/perl/python.perl
+10
-0
Doc/texinputs/python.sty
Doc/texinputs/python.sty
+3
-0
Doc/tools/sgmlconv/conversion.xml
Doc/tools/sgmlconv/conversion.xml
+6
-0
No files found.
Doc/doc/doc.tex
View file @
92350b3a
...
...
@@ -859,6 +859,14 @@ This \UNIX\ is also followed by a space.
The name of a Usenet newsgroup.
\end{macrodesc}
\begin{macrodesc}
{
note
}{
\p
{
text
}}
An especially important bit of information about an API that a
user should be aware of when using whatever bit of API the
note pertains to. This should be the last thing in the
paragraph as the end of the note is not visually marked in
any way.
\end{macrodesc}
\begin{macrodesc}
{
pep
}{
\p
{
number
}}
A reference to a Python Enhancement Proposal. This generates
appropriate index entries. The text
\samp
{
PEP
\var
{
number
}}
is
...
...
@@ -989,6 +997,15 @@ This \UNIX\ is also followed by a space.
explanation makes sense and may vary as needed.
\end{macrodesc}
\begin{macrodesc}
{
warning
}{
\p
{
text
}}
An important bit of information about an API that a user should
be very aware of when using whatever bit of API the warning
pertains to. This should be the last thing in the paragraph as
the end of the warning is not visually marked in any way. This
differs from
\macro
{
note
}
in that it is recommended over
\macro
{
note
}
for information regarding security.
\end{macrodesc}
\subsection
{
Module-specific Markup
\label
{
module-markup
}}
...
...
Doc/perl/python.perl
View file @
92350b3a
...
...
@@ -236,6 +236,16 @@ sub do_cmd_textbf{
return
use_wrappers
(
@_
[
0
],
'
<b>
',
'
</b>
');
}
sub
do_cmd_textit
{
return
use_wrappers
(
@_
[
0
],
'
<i>
',
'
</i>
');
}
sub
do_cmd_note
{
return
use_wrappers
(
@_
[
0
],
"
<span class=
\"
note
\"
><b class=
\"
label
\"
>Note:</b>
\n
",
'
</span>
');
}
sub
do_cmd_warning
{
return
use_wrappers
(
@_
[
0
],
"
<span class=
\"
warning
\"
><b class=
\"
label
\"
>Warning:</b>
\n
",
'
</span>
');
}
sub
do_cmd_moreargs
{
return
'
...
'
.
@_
[
0
];
}
...
...
Doc/texinputs/python.sty
View file @
92350b3a
...
...
@@ -881,6 +881,9 @@
\end{center}
}
\newcommand
{
\note
}
[1]
{
\strong
{
Note:
}
#1
}
\newcommand
{
\warning
}
[1]
{
\strong
{
Warning:
}
#1
}
% Deprecation stuff.
% Should be extended to allow an index / list of deprecated stuff. But
% there's a lot of stuff that needs to be done to make that automatable.
...
...
Doc/tools/sgmlconv/conversion.xml
View file @
92350b3a
...
...
@@ -55,6 +55,12 @@
<content/>
</macro>
<macro
name=
"shortversion"
/>
<macro
name=
"note"
>
<content/>
</macro>
<macro
name=
"warning"
>
<content/>
</macro>
<!-- These are broken: we need to re-order the optional and required
parameters, making the optional parameter the content for the
element. latex2esis.py is not powerful enough to handle this.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment