changeset 1909:be140a589f11

improved some module docstrings
author Thomas Waldmann <tw AT waldmann-edv DOT de>
date Sun, 25 Mar 2007 21:55:13 +0200
parents 8bd4b581cc60
children 5c3dffe2abf1
files MoinMoin/Page.py MoinMoin/PageEditor.py MoinMoin/PageGraphicalEditor.py MoinMoin/logfile/editlog.py MoinMoin/logfile/eventlog.py MoinMoin/user.py
diffstat 6 files changed, 22 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/MoinMoin/Page.py	Sun Mar 25 01:34:47 2007 +0100
+++ b/MoinMoin/Page.py	Sun Mar 25 21:55:13 2007 +0200
@@ -1,6 +1,13 @@
 # -*- coding: iso-8859-1 -*-
 """
     MoinMoin - Page class
+    
+    Page is used for read-only access to a wiki page. For r/w access see PageEditor.
+    A Page object is used to access a wiki page (in general) as well as to access
+    some specific revision of a wiki page.
+    
+    The RootPage is some virtual page located at / and is mainly used to do namespace
+    operations like getting the page list. 
 
     @copyright: 2000-2004 by Jürgen Hermann <jh@web.de>,
                 2005-2007 by MoinMoin:ThomasWaldmann,
--- a/MoinMoin/PageEditor.py	Sun Mar 25 01:34:47 2007 +0100
+++ b/MoinMoin/PageEditor.py	Sun Mar 25 21:55:13 2007 +0200
@@ -1,6 +1,8 @@
 # -*- coding: iso-8859-1 -*-
 """
     MoinMoin - PageEditor class
+    
+    PageEditor is used for r/w access to a wiki page (edit, rename, delete operations).
 
     @copyright: 2000-2004 by Jürgen Hermann <jh@web.de>
                 2005-2006 by MoinMoin:ThomasWaldmann
--- a/MoinMoin/PageGraphicalEditor.py	Sun Mar 25 01:34:47 2007 +0100
+++ b/MoinMoin/PageGraphicalEditor.py	Sun Mar 25 21:55:13 2007 +0200
@@ -2,6 +2,8 @@
 """
     MoinMoin - Call the GUI editor (FCKeditor)
 
+    Same as PageEditor, but we use the HTML based GUI editor here.
+
     @copyright: (c) Bastian Blank, Florian Festi, Thomas Waldmann
     @license: GNU GPL, see COPYING for details.
 """
--- a/MoinMoin/logfile/editlog.py	Sun Mar 25 01:34:47 2007 +0100
+++ b/MoinMoin/logfile/editlog.py	Sun Mar 25 21:55:13 2007 +0200
@@ -1,6 +1,9 @@
 """
     MoinMoin edit log class
 
+    This is used for accessing the global edit-log (e.g. by RecentChanges) as
+    well as for the local edit-log (e.g. PageEditor, info action).
+
     @license: GNU GPL, see COPYING for details.
 """
 
--- a/MoinMoin/logfile/eventlog.py	Sun Mar 25 01:34:47 2007 +0100
+++ b/MoinMoin/logfile/eventlog.py	Sun Mar 25 21:55:13 2007 +0200
@@ -1,5 +1,7 @@
 """
     MoinMoin event log class
+    
+    The global event-log is mainly used for statistics (e.g. EventStats).
 
     @license: GNU GPL, see COPYING for details.
 """
--- a/MoinMoin/user.py	Sun Mar 25 01:34:47 2007 +0100
+++ b/MoinMoin/user.py	Sun Mar 25 21:55:13 2007 +0200
@@ -1,6 +1,12 @@
 # -*- coding: iso-8859-1 -*-
 """
     MoinMoin - User Accounts
+    
+    This module contains functions to access user accounts (list all users, get
+    some specific user). User instances are used to access the user profile of
+    some specific user (name, password, email, bookmark, trail, settings, ...).
+
+    The UserPreferences form support stuff is in module userform.
 
     @copyright: 2000-2004 by Jürgen Hermann <jh@web.de>
     @license: GNU GPL, see COPYING for details.