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

Skip to content

Commit 930f134

Browse files
freddrakefreddrake
committed
Logical markup.
1 parent dd1f52b commit 930f134

2 files changed

Lines changed: 42 additions & 40 deletions

File tree

‎Doc/lib/libbinascii.tex‎

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
\section{Built-in Module \sectcode{binascii}}
1+
\section{Built-in Module \module{binascii}}
22
\label{module-binascii}
33
\bimodindex{binascii}
44

5-
The binascii module contains a number of methods to convert between
6-
binary and various ascii-encoded binary representations. Normally, you
7-
will not use these modules directly but use wrapper modules like
8-
\var{uu} or \var{hexbin} in stead, this module solely exists because
9-
bit-manipuation of large amounts of data is slow in python.
5+
The \module{binascii} module contains a number of methods to convert
6+
between binary and various \ASCII{}-encoded binary
7+
representations. Normally, you will not use these modules directly but
8+
use wrapper modules like \module{uu}\refstmodindex{uu} or
9+
\module{hexbin}\refstmodindex{hexbin} instead, this module solely
10+
exists because bit-manipuation of large amounts of data is slow in
11+
Python.
1012

11-
The \code{binascii} module defines the following functions:
12-
13-
\setindexsubitem{(in module binascii)}
13+
The \module{binascii} module defines the following functions:
1414

1515
\begin{funcdesc}{a2b_uu}{string}
1616
Convert a single line of uuencoded data back to binary and return the
@@ -19,9 +19,9 @@ \section{Built-in Module \sectcode{binascii}}
1919
\end{funcdesc}
2020

2121
\begin{funcdesc}{b2a_uu}{data}
22-
Convert binary data to a line of ascii characters, the return value is
23-
the converted line, including a newline char. The length of \var{data}
24-
should be at most 45.
22+
Convert binary data to a line of \ASCII{} characters, the return value
23+
is the converted line, including a newline char. The length of
24+
\var{data} should be at most 45.
2525
\end{funcdesc}
2626

2727
\begin{funcdesc}{a2b_base64}{string}
@@ -30,15 +30,15 @@ \section{Built-in Module \sectcode{binascii}}
3030
\end{funcdesc}
3131

3232
\begin{funcdesc}{b2a_base64}{data}
33-
Convert binary data to a line of ascii characters in base64 coding.
33+
Convert binary data to a line of \ASCII{} characters in base64 coding.
3434
The return value is the converted line, including a newline char.
3535
The length of \var{data} should be at most 57 to adhere to the base64
3636
standard.
3737
\end{funcdesc}
3838

3939
\begin{funcdesc}{a2b_hqx}{string}
40-
Convert binhex4 formatted ascii data to binary, without doing
41-
rle-decompression. The string should contain a complete number of
40+
Convert binhex4 formatted \ASCII{} data to binary, without doing
41+
RLE-decompression. The string should contain a complete number of
4242
binary bytes, or (in case of the last portion of the binhex4 data)
4343
have the remaining bits zero.
4444
\end{funcdesc}
@@ -49,7 +49,7 @@ \section{Built-in Module \sectcode{binascii}}
4949
indicator, followed by a count. A count of \code{0} specifies a byte
5050
value of \code{0x90}. The routine returns the decompressed data,
5151
unless data input data ends in an orphaned repeat indicator, in which
52-
case the \var{Incomplete} exception is raised.
52+
case the \exception{Incomplete} exception is raised.
5353
\end{funcdesc}
5454

5555
\begin{funcdesc}{rlecode_hqx}{data}
@@ -58,9 +58,9 @@ \section{Built-in Module \sectcode{binascii}}
5858
\end{funcdesc}
5959

6060
\begin{funcdesc}{b2a_hqx}{data}
61-
Perform hexbin4 binary-to-ascii translation and return the resulting
62-
string. The argument should already be rle-coded, and have a length
63-
divisible by 3 (except possibly the last fragment).
61+
Perform hexbin4 binary-to-\ASCII{} translation and return the
62+
resulting string. The argument should already be RLE-coded, and have a
63+
length divisible by 3 (except possibly the last fragment).
6464
\end{funcdesc}
6565

6666
\begin{funcdesc}{crc_hqx}{data, crc}
@@ -74,5 +74,6 @@ \section{Built-in Module \sectcode{binascii}}
7474

7575
\begin{excdesc}{Incomplete}
7676
Exception raised on incomplete data. These are usually not programming
77-
errors, but handled by reading a little more data and trying again.
77+
errors, but may be handled by reading a little more data and trying
78+
again.
7879
\end{excdesc}

‎Doc/libbinascii.tex‎

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
\section{Built-in Module \sectcode{binascii}}
1+
\section{Built-in Module \module{binascii}}
22
\label{module-binascii}
33
\bimodindex{binascii}
44

5-
The binascii module contains a number of methods to convert between
6-
binary and various ascii-encoded binary representations. Normally, you
7-
will not use these modules directly but use wrapper modules like
8-
\var{uu} or \var{hexbin} in stead, this module solely exists because
9-
bit-manipuation of large amounts of data is slow in python.
5+
The \module{binascii} module contains a number of methods to convert
6+
between binary and various \ASCII{}-encoded binary
7+
representations. Normally, you will not use these modules directly but
8+
use wrapper modules like \module{uu}\refstmodindex{uu} or
9+
\module{hexbin}\refstmodindex{hexbin} instead, this module solely
10+
exists because bit-manipuation of large amounts of data is slow in
11+
Python.
1012

11-
The \code{binascii} module defines the following functions:
12-
13-
\setindexsubitem{(in module binascii)}
13+
The \module{binascii} module defines the following functions:
1414

1515
\begin{funcdesc}{a2b_uu}{string}
1616
Convert a single line of uuencoded data back to binary and return the
@@ -19,9 +19,9 @@ \section{Built-in Module \sectcode{binascii}}
1919
\end{funcdesc}
2020

2121
\begin{funcdesc}{b2a_uu}{data}
22-
Convert binary data to a line of ascii characters, the return value is
23-
the converted line, including a newline char. The length of \var{data}
24-
should be at most 45.
22+
Convert binary data to a line of \ASCII{} characters, the return value
23+
is the converted line, including a newline char. The length of
24+
\var{data} should be at most 45.
2525
\end{funcdesc}
2626

2727
\begin{funcdesc}{a2b_base64}{string}
@@ -30,15 +30,15 @@ \section{Built-in Module \sectcode{binascii}}
3030
\end{funcdesc}
3131

3232
\begin{funcdesc}{b2a_base64}{data}
33-
Convert binary data to a line of ascii characters in base64 coding.
33+
Convert binary data to a line of \ASCII{} characters in base64 coding.
3434
The return value is the converted line, including a newline char.
3535
The length of \var{data} should be at most 57 to adhere to the base64
3636
standard.
3737
\end{funcdesc}
3838

3939
\begin{funcdesc}{a2b_hqx}{string}
40-
Convert binhex4 formatted ascii data to binary, without doing
41-
rle-decompression. The string should contain a complete number of
40+
Convert binhex4 formatted \ASCII{} data to binary, without doing
41+
RLE-decompression. The string should contain a complete number of
4242
binary bytes, or (in case of the last portion of the binhex4 data)
4343
have the remaining bits zero.
4444
\end{funcdesc}
@@ -49,7 +49,7 @@ \section{Built-in Module \sectcode{binascii}}
4949
indicator, followed by a count. A count of \code{0} specifies a byte
5050
value of \code{0x90}. The routine returns the decompressed data,
5151
unless data input data ends in an orphaned repeat indicator, in which
52-
case the \var{Incomplete} exception is raised.
52+
case the \exception{Incomplete} exception is raised.
5353
\end{funcdesc}
5454

5555
\begin{funcdesc}{rlecode_hqx}{data}
@@ -58,9 +58,9 @@ \section{Built-in Module \sectcode{binascii}}
5858
\end{funcdesc}
5959

6060
\begin{funcdesc}{b2a_hqx}{data}
61-
Perform hexbin4 binary-to-ascii translation and return the resulting
62-
string. The argument should already be rle-coded, and have a length
63-
divisible by 3 (except possibly the last fragment).
61+
Perform hexbin4 binary-to-\ASCII{} translation and return the
62+
resulting string. The argument should already be RLE-coded, and have a
63+
length divisible by 3 (except possibly the last fragment).
6464
\end{funcdesc}
6565

6666
\begin{funcdesc}{crc_hqx}{data, crc}
@@ -74,5 +74,6 @@ \section{Built-in Module \sectcode{binascii}}
7474

7575
\begin{excdesc}{Incomplete}
7676
Exception raised on incomplete data. These are usually not programming
77-
errors, but handled by reading a little more data and trying again.
77+
errors, but may be handled by reading a little more data and trying
78+
again.
7879
\end{excdesc}

0 commit comments

Comments
 (0)