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

Skip to content

Commit 921f32c

Browse files
committed
Mention abs(complex) -> magnitude (AMK).
Documented list(). Mention [raw_]input()'s interface to GNU readline.
1 parent 3a0d850 commit 921f32c

2 files changed

Lines changed: 36 additions & 6 deletions

File tree

Doc/lib/libfuncs.tex

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ \section{Built-in Functions}
77
\renewcommand{\indexsubitem}{(built-in function)}
88
\begin{funcdesc}{abs}{x}
99
Return the absolute value of a number. The argument may be a plain
10-
or long integer or a floating point number.
10+
or long integer or a floating point number. If the argument is a
11+
complex number, its magnitude is returned.
1112
\end{funcdesc}
1213

1314
\begin{funcdesc}{apply}{function\, args\optional{, keywords}}
@@ -221,7 +222,8 @@ \section{Built-in Functions}
221222

222223
\begin{funcdesc}{input}{\optional{prompt}}
223224
Almost equivalent to \code{eval(raw_input(\var{prompt}))}. Like
224-
\code{raw_input()}, the \var{prompt} argument is optional. The difference
225+
\code{raw_input()}, the \var{prompt} argument is optional, and GNU
226+
readline is used when configured. The difference
225227
is that a long input expression may be broken over multiple lines using
226228
the backslash convention.
227229
\end{funcdesc}
@@ -256,6 +258,15 @@ \section{Built-in Functions}
256258
may be a sequence (string, tuple or list) or a mapping (dictionary).
257259
\end{funcdesc}
258260

261+
\begin{funcdesc}{list}{sequence}
262+
Return a list whose items are the same and in the same order as
263+
\var{sequence}'s items. If \var{sequence} is already a list,
264+
a copy is made and returned, similar to \code{\var{sequence}[:]}.
265+
For instance, \code{list('abc')} returns
266+
returns \code{['a', 'b', 'c']} and \code{list( (1, 2, 3) )} returns
267+
\code{[1, 2, 3]}.
268+
\end{funcdesc}
269+
259270
\begin{funcdesc}{locals}{}
260271
Return a dictionary representing the current local symbol table.
261272
Inside a function, modifying this dictionary does not always have the
@@ -400,6 +411,10 @@ \section{Built-in Functions}
400411
"Monty Python's Flying Circus"
401412
>>>
402413
\end{verbatim}\ecode
414+
415+
If the interpreter was built to use the GNU readline library, then
416+
\code{raw_input()} will use it to provide elaborate
417+
line editing and history features.
403418
\end{funcdesc}
404419

405420
\begin{funcdesc}{reduce}{function\, list\optional{\, initializer}}
@@ -494,7 +509,7 @@ \section{Built-in Functions}
494509

495510
\begin{funcdesc}{tuple}{sequence}
496511
Return a tuple whose items are the same and in the same order as
497-
\var{sequence}'s items. If \var{sequence} is alread a tuple, it
512+
\var{sequence}'s items. If \var{sequence} is already a tuple, it
498513
is returned unchanged. For instance, \code{tuple('abc')} returns
499514
returns \code{('a', 'b', 'c')} and \code{tuple([1, 2, 3])} returns
500515
\code{(1, 2, 3)}.

Doc/libfuncs.tex

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ \section{Built-in Functions}
77
\renewcommand{\indexsubitem}{(built-in function)}
88
\begin{funcdesc}{abs}{x}
99
Return the absolute value of a number. The argument may be a plain
10-
or long integer or a floating point number.
10+
or long integer or a floating point number. If the argument is a
11+
complex number, its magnitude is returned.
1112
\end{funcdesc}
1213

1314
\begin{funcdesc}{apply}{function\, args\optional{, keywords}}
@@ -221,7 +222,8 @@ \section{Built-in Functions}
221222

222223
\begin{funcdesc}{input}{\optional{prompt}}
223224
Almost equivalent to \code{eval(raw_input(\var{prompt}))}. Like
224-
\code{raw_input()}, the \var{prompt} argument is optional. The difference
225+
\code{raw_input()}, the \var{prompt} argument is optional, and GNU
226+
readline is used when configured. The difference
225227
is that a long input expression may be broken over multiple lines using
226228
the backslash convention.
227229
\end{funcdesc}
@@ -256,6 +258,15 @@ \section{Built-in Functions}
256258
may be a sequence (string, tuple or list) or a mapping (dictionary).
257259
\end{funcdesc}
258260

261+
\begin{funcdesc}{list}{sequence}
262+
Return a list whose items are the same and in the same order as
263+
\var{sequence}'s items. If \var{sequence} is already a list,
264+
a copy is made and returned, similar to \code{\var{sequence}[:]}.
265+
For instance, \code{list('abc')} returns
266+
returns \code{['a', 'b', 'c']} and \code{list( (1, 2, 3) )} returns
267+
\code{[1, 2, 3]}.
268+
\end{funcdesc}
269+
259270
\begin{funcdesc}{locals}{}
260271
Return a dictionary representing the current local symbol table.
261272
Inside a function, modifying this dictionary does not always have the
@@ -400,6 +411,10 @@ \section{Built-in Functions}
400411
"Monty Python's Flying Circus"
401412
>>>
402413
\end{verbatim}\ecode
414+
415+
If the interpreter was built to use the GNU readline library, then
416+
\code{raw_input()} will use it to provide elaborate
417+
line editing and history features.
403418
\end{funcdesc}
404419

405420
\begin{funcdesc}{reduce}{function\, list\optional{\, initializer}}
@@ -494,7 +509,7 @@ \section{Built-in Functions}
494509

495510
\begin{funcdesc}{tuple}{sequence}
496511
Return a tuple whose items are the same and in the same order as
497-
\var{sequence}'s items. If \var{sequence} is alread a tuple, it
512+
\var{sequence}'s items. If \var{sequence} is already a tuple, it
498513
is returned unchanged. For instance, \code{tuple('abc')} returns
499514
returns \code{('a', 'b', 'c')} and \code{tuple([1, 2, 3])} returns
500515
\code{(1, 2, 3)}.

0 commit comments

Comments
 (0)