Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit cce1090

Browse files
freddrakefreddrake
committed
Change "\," to just "," in function signatures. This is easier to maintain,
works better with LaTeX2HTML, and allows some simplification of the python.sty macros.
1 parent c9a4438 commit cce1090

129 files changed

Lines changed: 705 additions & 703 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎Doc/lib/libaifc.tex‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ \section{Standard Module \sectcode{aifc}}
2424
Module \code{aifc} defines the following function:
2525

2626
\setindexsubitem{(in module aifc)}
27-
\begin{funcdesc}{open}{file\, mode}
27+
\begin{funcdesc}{open}{file, mode}
2828
Open an AIFF or AIFF-C file and return an object instance with
2929
methods that are described below. The argument file is either a
3030
string naming a file or a file object. The mode is either the string
@@ -146,7 +146,7 @@ \section{Standard Module \sectcode{aifc}}
146146
support seeking.
147147
\end{funcdesc}
148148

149-
\begin{funcdesc}{setcomptype}{type\, name}
149+
\begin{funcdesc}{setcomptype}{type, name}
150150
Specify the compression type. If not specified, the audio data will
151151
not be compressed. In AIFF files, compression is not possible. The
152152
name parameter should be a human-readable description of the
@@ -155,14 +155,14 @@ \section{Standard Module \sectcode{aifc}}
155155
NONE, ULAW, ALAW, G722.
156156
\end{funcdesc}
157157

158-
\begin{funcdesc}{setparams}{nchannels\, sampwidth\, framerate\, comptype\, compname}
158+
\begin{funcdesc}{setparams}{nchannels, sampwidth, framerate, comptype, compname}
159159
Set all the above parameters at once. The argument is a tuple
160160
consisting of the various parameters. This means that it is possible
161161
to use the result of a \code{getparams()} call as argument to
162162
\code{setparams()}.
163163
\end{funcdesc}
164164

165-
\begin{funcdesc}{setmark}{id\, pos\, name}
165+
\begin{funcdesc}{setmark}{id, pos, name}
166166
Add a mark with the given id (larger than 0), and the given name at
167167
the given position. This method can be called at any time before
168168
\code{close()}.

‎Doc/lib/libal.tex‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ \section{Built-in Module \sectcode{al}}
2727

2828
\setindexsubitem{(in module al)}
2929

30-
\begin{funcdesc}{openport}{name\, direction\optional{\, config}}
30+
\begin{funcdesc}{openport}{name, direction\optional{, config}}
3131
The name and direction arguments are strings. The optional config
3232
argument is a configuration object as returned by
3333
\code{al.newconfig()}. The return value is an \dfn{port object};
@@ -44,12 +44,12 @@ \section{Built-in Module \sectcode{al}}
4444
integers containing the data returned by ALqueryparams().
4545
\end{funcdesc}
4646

47-
\begin{funcdesc}{getparams}{device\, list}
47+
\begin{funcdesc}{getparams}{device, list}
4848
The device argument is an integer. The list argument is a list such
4949
as returned by \code{queryparams}; it is modified in place (!).
5050
\end{funcdesc}
5151

52-
\begin{funcdesc}{setparams}{device\, list}
52+
\begin{funcdesc}{setparams}{device, list}
5353
The device argument is an integer. The list argument is a list such
5454
as returned by \code{al.queryparams}.
5555
\end{funcdesc}

‎Doc/lib/libamoeba.tex‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ \section{Built-in Module \sectcode{amoeba}}
1212
The module \code{amoeba} defines the following items:
1313

1414
\setindexsubitem{(in module amoeba)}
15-
\begin{funcdesc}{name_append}{path\, cap}
15+
\begin{funcdesc}{name_append}{path, cap}
1616
Stores a capability in the Amoeba directory tree.
1717
Arguments are the pathname (a string) and the capability (a capability
1818
object as returned by
@@ -32,7 +32,7 @@ \section{Built-in Module \sectcode{amoeba}}
3232
object, to which various interesting operations apply, described below.
3333
\end{funcdesc}
3434

35-
\begin{funcdesc}{name_replace}{path\, cap}
35+
\begin{funcdesc}{name_replace}{path, cap}
3636
Replaces a capability in the Amoeba directory tree.
3737
Arguments are the pathname and the new capability.
3838
(This differs from
@@ -91,7 +91,7 @@ \subsection{Capability Operations}
9191
Returns a list of the names of the entries in an Amoeba directory.
9292
\end{funcdesc}
9393

94-
\begin{funcdesc}{b_read}{offset\, maxsize}
94+
\begin{funcdesc}{b_read}{offset, maxsize}
9595
Reads (at most)
9696
\var{maxsize}
9797
bytes from a bullet file at offset

‎Doc/lib/libanydbm.tex‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ \section{Standard Modules \sectcode{anydbm} and \sectcode{dumbdbm}}
1313
% at the same time.
1414
\setindexsubitem{(in modules anydbm, dumbdbm)}
1515

16-
\begin{funcdesc}{open}{filename\optional{\, flag\, mode}}
16+
\begin{funcdesc}{open}{filename\optional{, flag, mode}}
1717
Open the database file \var{filename} and return a corresponding object.
1818
The optional \var{flag} argument can be
1919
\code{'r'} to open an existing database for reading only,

‎Doc/lib/libarray.tex‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ \section{Built-in Module \sectcode{array}}
3535

3636
The module defines the following function:
3737

38-
\begin{funcdesc}{array}{typecode\optional{\, initializer}}
38+
\begin{funcdesc}{array}{typecode\optional{, initializer}}
3939
Return a new array whose items are restricted by \var{typecode}, and
4040
initialized from the optional \var{initializer} value, which must be a
4141
list or a string. The list or string is passed to the new array's
@@ -77,7 +77,7 @@ \section{Built-in Module \sectcode{array}}
7777
on a machine with a different byte order.
7878
\end{funcdesc}
7979

80-
\begin{funcdesc}{fromfile}{f\, n}
80+
\begin{funcdesc}{fromfile}{f, n}
8181
Read \var{n} items (as machine values) from the file object \var{f}
8282
and append them to the end of the array. If less than \var{n} items
8383
are available, \exception{EOFError} is raised, but the items that were
@@ -98,12 +98,12 @@ \section{Built-in Module \sectcode{array}}
9898
file using the \method{fromfile()} method).
9999
\end{funcdesc}
100100

101-
\begin{funcdesc}{insert}{i\, x}
101+
\begin{funcdesc}{insert}{i, x}
102102
Insert a new item with value \var{x} in the array before position
103103
\var{i}.
104104
\end{funcdesc}
105105

106-
\begin{funcdesc}{read}{f\, n}
106+
\begin{funcdesc}{read}{f, n}
107107
\deprecated {1.5.1}
108108
{Use the \method{fromfile()} method.}
109109
Read \var{n} items (as machine values) from the file object \var{f}

‎Doc/lib/libaudioop.tex‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -19,46 +19,46 @@ \section{Built-in Module \sectcode{audioop}}
1919
per sample, etc.
2020
\end{excdesc}
2121

22-
\begin{funcdesc}{add}{fragment1\, fragment2\, width}
22+
\begin{funcdesc}{add}{fragment1, fragment2, width}
2323
Return a fragment which is the addition of the two samples passed as
2424
parameters. \var{width} is the sample width in bytes, either
2525
\code{1}, \code{2} or \code{4}. Both fragments should have the same
2626
length.
2727
\end{funcdesc}
2828

29-
\begin{funcdesc}{adpcm2lin}{adpcmfragment\, width\, state}
29+
\begin{funcdesc}{adpcm2lin}{adpcmfragment, width, state}
3030
Decode an Intel/DVI ADPCM coded fragment to a linear fragment. See
3131
the description of \code{lin2adpcm} for details on ADPCM coding.
3232
Return a tuple \code{(\var{sample}, \var{newstate})} where the sample
3333
has the width specified in \var{width}.
3434
\end{funcdesc}
3535

36-
\begin{funcdesc}{adpcm32lin}{adpcmfragment\, width\, state}
36+
\begin{funcdesc}{adpcm32lin}{adpcmfragment, width, state}
3737
Decode an alternative 3-bit ADPCM code. See \code{lin2adpcm3} for
3838
details.
3939
\end{funcdesc}
4040

41-
\begin{funcdesc}{avg}{fragment\, width}
41+
\begin{funcdesc}{avg}{fragment, width}
4242
Return the average over all samples in the fragment.
4343
\end{funcdesc}
4444

45-
\begin{funcdesc}{avgpp}{fragment\, width}
45+
\begin{funcdesc}{avgpp}{fragment, width}
4646
Return the average peak-peak value over all samples in the fragment.
4747
No filtering is done, so the usefulness of this routine is
4848
questionable.
4949
\end{funcdesc}
5050

51-
\begin{funcdesc}{bias}{fragment\, width\, bias}
51+
\begin{funcdesc}{bias}{fragment, width, bias}
5252
Return a fragment that is the original fragment with a bias added to
5353
each sample.
5454
\end{funcdesc}
5555

56-
\begin{funcdesc}{cross}{fragment\, width}
56+
\begin{funcdesc}{cross}{fragment, width}
5757
Return the number of zero crossings in the fragment passed as an
5858
argument.
5959
\end{funcdesc}
6060

61-
\begin{funcdesc}{findfactor}{fragment\, reference}
61+
\begin{funcdesc}{findfactor}{fragment, reference}
6262
Return a factor \var{F} such that
6363
\code{rms(add(fragment, mul(reference, -F)))} is minimal, i.e.,
6464
return the factor with which you should multiply \var{reference} to
@@ -68,7 +68,7 @@ \section{Built-in Module \sectcode{audioop}}
6868
The time taken by this routine is proportional to \code{len(fragment)}.
6969
\end{funcdesc}
7070

71-
\begin{funcdesc}{findfit}{fragment\, reference}
71+
\begin{funcdesc}{findfit}{fragment, reference}
7272
This routine (which only accepts 2-byte sample fragments)
7373

7474
Try to match \var{reference} as well as possible to a portion of
@@ -82,7 +82,7 @@ \section{Built-in Module \sectcode{audioop}}
8282
\code{findfactor}.
8383
\end{funcdesc}
8484

85-
\begin{funcdesc}{findmax}{fragment\, length}
85+
\begin{funcdesc}{findmax}{fragment, length}
8686
Search \var{fragment} for a slice of length \var{length} samples (not
8787
bytes!)\ with maximum energy, i.e., return \var{i} for which
8888
\code{rms(fragment[i*2:(i+length)*2])} is maximal. The fragments
@@ -91,15 +91,15 @@ \section{Built-in Module \sectcode{audioop}}
9191
The routine takes time proportional to \code{len(fragment)}.
9292
\end{funcdesc}
9393

94-
\begin{funcdesc}{getsample}{fragment\, width\, index}
94+
\begin{funcdesc}{getsample}{fragment, width, index}
9595
Return the value of sample \var{index} from the fragment.
9696
\end{funcdesc}
9797

98-
\begin{funcdesc}{lin2lin}{fragment\, width\, newwidth}
98+
\begin{funcdesc}{lin2lin}{fragment, width, newwidth}
9999
Convert samples between 1-, 2- and 4-byte formats.
100100
\end{funcdesc}
101101

102-
\begin{funcdesc}{lin2adpcm}{fragment\, width\, state}
102+
\begin{funcdesc}{lin2adpcm}{fragment, width, state}
103103
Convert samples to 4 bit Intel/DVI ADPCM encoding. ADPCM coding is an
104104
adaptive coding scheme, whereby each 4 bit number is the difference
105105
between one sample and the next, divided by a (varying) step. The
@@ -113,41 +113,41 @@ \section{Built-in Module \sectcode{audioop}}
113113
is the ADPCM coded fragment packed 2 4-bit values per byte.
114114
\end{funcdesc}
115115

116-
\begin{funcdesc}{lin2adpcm3}{fragment\, width\, state}
116+
\begin{funcdesc}{lin2adpcm3}{fragment, width, state}
117117
This is an alternative ADPCM coder that uses only 3 bits per sample.
118118
It is not compatible with the Intel/DVI ADPCM coder and its output is
119119
not packed (due to laziness on the side of the author). Its use is
120120
discouraged.
121121
\end{funcdesc}
122122

123-
\begin{funcdesc}{lin2ulaw}{fragment\, width}
123+
\begin{funcdesc}{lin2ulaw}{fragment, width}
124124
Convert samples in the audio fragment to U-LAW encoding and return
125125
this as a Python string. U-LAW is an audio encoding format whereby
126126
you get a dynamic range of about 14 bits using only 8 bit samples. It
127127
is used by the Sun audio hardware, among others.
128128
\end{funcdesc}
129129

130-
\begin{funcdesc}{minmax}{fragment\, width}
130+
\begin{funcdesc}{minmax}{fragment, width}
131131
Return a tuple consisting of the minimum and maximum values of all
132132
samples in the sound fragment.
133133
\end{funcdesc}
134134

135-
\begin{funcdesc}{max}{fragment\, width}
135+
\begin{funcdesc}{max}{fragment, width}
136136
Return the maximum of the \emph{absolute value} of all samples in a
137137
fragment.
138138
\end{funcdesc}
139139

140-
\begin{funcdesc}{maxpp}{fragment\, width}
140+
\begin{funcdesc}{maxpp}{fragment, width}
141141
Return the maximum peak-peak value in the sound fragment.
142142
\end{funcdesc}
143143

144-
\begin{funcdesc}{mul}{fragment\, width\, factor}
144+
\begin{funcdesc}{mul}{fragment, width, factor}
145145
Return a fragment that has all samples in the original framgent
146146
multiplied by the floating-point value \var{factor}. Overflow is
147147
silently ignored.
148148
\end{funcdesc}
149149

150-
\begin{funcdesc}{ratecv}{fragment\, width\, nchannels\, inrate\, outrate\, state\optional{\, weightA\, weightB}}
150+
\begin{funcdesc}{ratecv}{fragment, width, nchannels, inrate, outrate, state\optional{, weightA, weightB}}
151151
Convert the frame rate of the input fragment.
152152

153153
\code{State} is a tuple containing the state of the converter. The
@@ -158,11 +158,11 @@ \section{Built-in Module \sectcode{audioop}}
158158
simple digital filter and default to 1 and 0 respectively.
159159
\end{funcdesc}
160160

161-
\begin{funcdesc}{reverse}{fragment\, width}
161+
\begin{funcdesc}{reverse}{fragment, width}
162162
Reverse the samples in a fragment and returns the modified fragment.
163163
\end{funcdesc}
164164

165-
\begin{funcdesc}{rms}{fragment\, width}
165+
\begin{funcdesc}{rms}{fragment, width}
166166
Return the root-mean-square of the fragment, i.e.
167167
\iftexi
168168
the square root of the quotient of the sum of all squared sample value,
@@ -177,20 +177,20 @@ \section{Built-in Module \sectcode{audioop}}
177177
This is a measure of the power in an audio signal.
178178
\end{funcdesc}
179179

180-
\begin{funcdesc}{tomono}{fragment\, width\, lfactor\, rfactor}
180+
\begin{funcdesc}{tomono}{fragment, width, lfactor, rfactor}
181181
Convert a stereo fragment to a mono fragment. The left channel is
182182
multiplied by \var{lfactor} and the right channel by \var{rfactor}
183183
before adding the two channels to give a mono signal.
184184
\end{funcdesc}
185185

186-
\begin{funcdesc}{tostereo}{fragment\, width\, lfactor\, rfactor}
186+
\begin{funcdesc}{tostereo}{fragment, width, lfactor, rfactor}
187187
Generate a stereo fragment from a mono fragment. Each pair of samples
188188
in the stereo fragment are computed from the mono sample, whereby left
189189
channel samples are multiplied by \var{lfactor} and right channel
190190
samples by \var{rfactor}.
191191
\end{funcdesc}
192192

193-
\begin{funcdesc}{ulaw2lin}{fragment\, width}
193+
\begin{funcdesc}{ulaw2lin}{fragment, width}
194194
Convert sound fragments in ULAW encoding to linearly encoded sound
195195
fragments. ULAW encoding always uses 8 bits samples, so \var{width}
196196
refers only to the sample width of the output fragment here.

‎Doc/lib/libbasehttp.tex‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -157,15 +157,15 @@ \section{Standard Module \sectcode{BaseHTTPServer}}
157157
class variable.
158158
\end{funcdesc}
159159

160-
\begin{funcdesc}{send_response}{code\optional{\, message}}
160+
\begin{funcdesc}{send_response}{code\optional{, message}}
161161
Sends a response header and logs the accepted request. The HTTP
162162
response line is sent, followed by \emph{Server} and \emph{Date}
163163
headers. The values for these two headers are picked up from the
164164
\method{version_string()} and \method{date_time_string()} methods,
165165
respectively.
166166
\end{funcdesc}
167167

168-
\begin{funcdesc}{send_header}{keyword\, value}
168+
\begin{funcdesc}{send_header}{keyword, value}
169169
Writes a specific MIME header to the output stream. \var{keyword}
170170
should specify the header keyword, with \var{value} specifying
171171
its value.
@@ -176,7 +176,7 @@ \section{Standard Module \sectcode{BaseHTTPServer}}
176176
the response.
177177
\end{funcdesc}
178178

179-
\begin{funcdesc}{log_request}{\optional{code\optional{\, size}}}
179+
\begin{funcdesc}{log_request}{\optional{code\optional{, size}}}
180180
Logs an accepted (successful) request. \var{code} should specify
181181
the numeric HTTP code associated with the response. If a size of
182182
the response is available, then it should be passed as the

‎Doc/lib/libbastion.tex‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ \section{Standard Module \sectcode{Bastion}}
1717

1818
% I've punted on the issue of documenting keyword arguments for now.
1919

20-
\begin{funcdesc}{Bastion}{object\optional{\, filter\, name\, class}}
20+
\begin{funcdesc}{Bastion}{object\optional{, filter, name, class}}
2121
Protect the object \var{object}, returning a bastion for the
2222
object. Any attempt to access one of the object's attributes will
2323
have to be approved by the \var{filter} function; if the access is

‎Doc/lib/libbinhex.tex‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@ \section{Standard Module \sectcode{binhex}}
1111

1212
\setindexsubitem{(in module binhex)}
1313

14-
\begin{funcdesc}{binhex}{input\, output}
14+
\begin{funcdesc}{binhex}{input, output}
1515
Convert a binary file with filename \var{input} to binhex file
1616
\var{output}. The \var{output} parameter can either be a filename or a
1717
file-like object (any object supporting a \var{write} and \var{close}
1818
method).
1919
\end{funcdesc}
2020

21-
\begin{funcdesc}{hexbin}{input\optional{\, output}}
21+
\begin{funcdesc}{hexbin}{input\optional{, output}}
2222
Decode a binhex file \var{input}. \var{input} may be a filename or a
2323
file-like object supporting \var{read} and \var{close} methods.
2424
The resulting file is written to a file named \var{output}, unless the

‎Doc/lib/libcgi.tex‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ \subsection{Functions}
191191
\mimetype{application/x-www-form-urlencoded}).
192192
\end{funcdesc}
193193

194-
\begin{funcdesc}{parse_multipart}{fp\, pdict}
194+
\begin{funcdesc}{parse_multipart}{fp, pdict}
195195
Parse input of type \mimetype{multipart/form-data} (for
196196
file uploads). Arguments are \var{fp} for the input file and
197197
\var{pdict} for the dictionary containing other parameters of
@@ -236,7 +236,7 @@ \subsection{Functions}
236236
HTML.
237237
\end{funcdesc}
238238

239-
\begin{funcdesc}{escape}{s\optional{\, quote}}
239+
\begin{funcdesc}{escape}{s\optional{, quote}}
240240
Convert the characters
241241
\character{\&}, \character{<} and \character{>} in string \var{s} to
242242
HTML-safe sequences. Use this if you need to display text that might

0 commit comments

Comments
 (0)