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

Skip to content

Commit 1ce3604

Browse files
freddrakefreddrake
committed
Separate UserDict and UserList documentation into separate sections.
1 parent df0e3fc commit 1ce3604

2 files changed

Lines changed: 52 additions & 20 deletions

File tree

‎Doc/lib/libuserdict.tex‎

Lines changed: 26 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,13 @@
1-
\section{Standard Modules \module{UserDict} and \module{UserList}}
2-
\nodename{UserDict and UserList}
1+
\section{Standard Module \module{UserDict}}
32
\stmodindex{UserDict}
4-
\stmodindex{UserList}
53
\label{module-UserDict}
6-
\label{module-UserList}
74

8-
Each of these modules defines a class that acts as a wrapper around
9-
either dictionary or list objects. They're useful base classes for
10-
your own dictionary-like or list-like classes, which can inherit from
5+
This module defines a class that acts as a wrapper around
6+
dictionary objects. It is a useful base class for
7+
your own dictionary-like classes, which can inherit from
118
them and override existing methods or add new ones. In this way one
12-
can add new behaviours to dictionaries or lists.
9+
can add new behaviours to dictionaries.
1310

14-
\setindexsubitem{(in module UserDict)}
1511
The \module{UserDict} module defines the \class{UserDict} class:
1612

1713
\begin{classdesc}{UserDict}{}
@@ -20,7 +16,22 @@ \section{Standard Modules \module{UserDict} and \module{UserList}}
2016
\member{data} attribute of \class{UserDict} instances.
2117
\end{classdesc}
2218

23-
\setindexsubitem{(in module UserList)}
19+
\begin{memberdesc}{data}
20+
A real dictionary used to store the contents of the \class{UserDict}
21+
class.
22+
\end{memberdesc}
23+
24+
25+
\section{Standard Module \module{UserList}}
26+
\stmodindex{UserList}
27+
\label{module-UserList}
28+
29+
This module defines a class that acts as a wrapper around
30+
list objects. It is a useful base class for
31+
your own list-like classes, which can inherit from
32+
them and override existing methods or add new ones. In this way one
33+
can add new behaviours to lists.
34+
2435
The \module{UserList} module defines the \class{UserList} class:
2536

2637
\begin{classdesc}{UserList}{\optional{list}}
@@ -31,3 +42,8 @@ \section{Standard Modules \module{UserDict} and \module{UserList}}
3142
empty list \code{[]}. \var{list} can be either a regular Python list,
3243
or an instance of \class{UserList} (or a subclass).
3344
\end{classdesc}
45+
46+
\begin{memberdesc}{data}
47+
A real Python list object used to store the contents of the
48+
\class{UserList} class.
49+
\end{memberdesc}

‎Doc/libuserdict.tex‎

Lines changed: 26 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,13 @@
1-
\section{Standard Modules \module{UserDict} and \module{UserList}}
2-
\nodename{UserDict and UserList}
1+
\section{Standard Module \module{UserDict}}
32
\stmodindex{UserDict}
4-
\stmodindex{UserList}
53
\label{module-UserDict}
6-
\label{module-UserList}
74

8-
Each of these modules defines a class that acts as a wrapper around
9-
either dictionary or list objects. They're useful base classes for
10-
your own dictionary-like or list-like classes, which can inherit from
5+
This module defines a class that acts as a wrapper around
6+
dictionary objects. It is a useful base class for
7+
your own dictionary-like classes, which can inherit from
118
them and override existing methods or add new ones. In this way one
12-
can add new behaviours to dictionaries or lists.
9+
can add new behaviours to dictionaries.
1310

14-
\setindexsubitem{(in module UserDict)}
1511
The \module{UserDict} module defines the \class{UserDict} class:
1612

1713
\begin{classdesc}{UserDict}{}
@@ -20,7 +16,22 @@ \section{Standard Modules \module{UserDict} and \module{UserList}}
2016
\member{data} attribute of \class{UserDict} instances.
2117
\end{classdesc}
2218

23-
\setindexsubitem{(in module UserList)}
19+
\begin{memberdesc}{data}
20+
A real dictionary used to store the contents of the \class{UserDict}
21+
class.
22+
\end{memberdesc}
23+
24+
25+
\section{Standard Module \module{UserList}}
26+
\stmodindex{UserList}
27+
\label{module-UserList}
28+
29+
This module defines a class that acts as a wrapper around
30+
list objects. It is a useful base class for
31+
your own list-like classes, which can inherit from
32+
them and override existing methods or add new ones. In this way one
33+
can add new behaviours to lists.
34+
2435
The \module{UserList} module defines the \class{UserList} class:
2536

2637
\begin{classdesc}{UserList}{\optional{list}}
@@ -31,3 +42,8 @@ \section{Standard Modules \module{UserDict} and \module{UserList}}
3142
empty list \code{[]}. \var{list} can be either a regular Python list,
3243
or an instance of \class{UserList} (or a subclass).
3344
\end{classdesc}
45+
46+
\begin{memberdesc}{data}
47+
A real Python list object used to store the contents of the
48+
\class{UserList} class.
49+
\end{memberdesc}

0 commit comments

Comments
 (0)