diff options
author | James Vasile <james@jamesvasile.com> | 2013-02-08 09:51:33 -0500 |
---|---|---|
committer | James Vasile <james@jamesvasile.com> | 2013-02-08 11:31:06 -0500 |
commit | 2e1240ad18ac0e5bcd7116816b812454af726cbf (patch) | |
tree | 42819140cffe1c4993f5c4bc997acd4faa4df906 | |
parent | f3d4604b7f534870e5b79cb922d908058f44e936 (diff) |
added some more documentation
-rw-r--r-- | modules/installed/lib/forms.py | 20 | ||||
-rw-r--r-- | plugin_mount.py | 6 |
2 files changed, 25 insertions, 1 deletions
diff --git a/modules/installed/lib/forms.py b/modules/installed/lib/forms.py index df78eea..00ad43f 100644 --- a/modules/installed/lib/forms.py +++ b/modules/installed/lib/forms.py @@ -1,3 +1,23 @@ +""" +The Form class is a helper class that takes parameters and method +calls and can return html for a form with appropriate hooks for css +styling. It should allow you to display a form but have the +formatting and styling added by the class. You can worry less about +how it looks while still getting consistent, decent-looking forms. + +Take a look at the FirstBoot class for an example of forms in action. + +Copyright 2011-2013 James Vasile + +This software is released to you (yes, you) under the terms of the GNU +Affero General Public License, version 3 or later, available at +<http://www.gnu.org/licenses/agpl.html>. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU Affero General Public License for more details. +""" class Form(): def __init__(self, action=None, cls='form', title=None, onsubmit=None, name=None, message='', method="get"): """Note that there appears to be a bug in cherrypy whereby diff --git a/plugin_mount.py b/plugin_mount.py index 5ad414a..94f4d21 100644 --- a/plugin_mount.py +++ b/plugin_mount.py @@ -165,6 +165,10 @@ class UserStoreModule: user_store.py: get, get_all, set, exists, remove, attr, expert. See source code for doc strings. + This is designed as a plugin so mutiple types of user store can be + supported. But the project is moving towards LDAP for + compatibility with third party software. A future version of + Plinth is likely to require LDAP. """ - __metaclass__ = PluginMountSingular + __metaclass__ = PluginMountSingular # singular because we can only use one user store at a time |