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
c0ed9c49
Commit
c0ed9c49
authored
Jul 13, 2004
by
Fred Drake
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
clarify where \versionadded and \versionchanged should be placed when
they are used
parent
e45d5a3b
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
28 additions
and
20 deletions
+28
-20
Doc/doc/doc.tex
Doc/doc/doc.tex
+28
-20
No files found.
Doc/doc/doc.tex
View file @
c0ed9c49
...
...
@@ -1018,15 +1018,37 @@ This \UNIX\ is also followed by a space.
\macro
{
shortversion
}
macro.
\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. The
content of
\var
{
text
}
should be written in complete sentences
and include all appropriate punctuation. This differs from
\macro
{
note
}
in that it is recommended over
\macro
{
note
}
for
information regarding security.
\end{macrodesc}
The following two macros are used to describe information that's
associated with changes from one release to another. For features
which are described by a single paragraph, these are typically
added as separate source lines at the end of the paragraph. When
adding these to features described by multiple paragraphs, they
are usually collected in a single separate paragraph after the
description. When both
\macro
{
versionadded
}
and
\macro
{
versionchanged
}
are used,
\macro
{
versionadded
}
should come
first; the versions should be listed in chronological order. Both
of these should come before availability statements. The location
should be selected so the explanation makes sense and may vary as
needed.
\begin{macrodesc}
{
versionadded
}{
\op
{
explanation
}
\p
{
version
}}
The version of Python which added the described feature to the
library or C API.
\var
{
explanation
}
should be a
\emph
{
brief
}
explanation of the change consisting of a capitalized sentence
fragment; a period will be appended by the formatting process.
This is typically added to the end of the first paragraph of the
description before any availability notes. The location should
be selected so the explanation makes sense and may vary as
needed.
When this applies to an entire module, it should be placed at
the top of the module section before any prose.
\end{macrodesc}
\begin{macrodesc}
{
versionchanged
}{
\op
{
explanation
}
\p
{
version
}}
...
...
@@ -1034,22 +1056,8 @@ This \UNIX\ is also followed by a space.
some way (new parameters, changed side effects, etc.).
\var
{
explanation
}
should be a
\emph
{
brief
}
explanation of the
change consisting of a capitalized sentence fragment; a
period will be appended by the formatting process.
This is typically added to the end of the first paragraph of the
description before any availability notes and after
\macro
{
versionadded
}
. The location should be selected so the
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. The
content of
\var
{
text
}
should be written in complete sentences
and include all appropriate punctuation. This differs from
\macro
{
note
}
in that it is recommended over
\macro
{
note
}
for
information regarding security.
period will be appended by the formatting process. This should
not generally be applied to modules.
\end{macrodesc}
...
...
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