Anonymous avatar Anonymous committed 663c611

Docs.

Comments (0)

Files changed (2)

 
 WebHelpers provides functions useful in web applications: generating HTML tags,
 showing results a pageful at a time, etc.  It may be used with any web
-framework or template engine.  A brief summary of the module layout is below;
-see the docstrings in the source for documentation.
+framework or template engine.  A brief outline is below, but see the
+documentation and module docstrings for a more complete list.
 
 ``constants``
     Country codes, states and provinces.
     (request, response, session, etc) or other aspects of Pylons and its
     dependencies.  Most can be ported to other frameworks with little effort.
     
-``string24``
-    The ``string`` module from Python 2.4.  Useful if you're running on
-    Python 2.3.
-
 ``tags``
     Helpers producing simple HTML tags.
 
 WebHelpers TODO
 ===============
 
+WebHelpers 1.x is in a soft feature freeze, so only bugfixes and small changes
+are likely to be made in the foreseeable future.
+
 See also the bug list at http://bigbucket.org/bbangert/webhelpers .
 
-``webhelpers.text.convert_misc_characters`` fails tests. It's producing
-incorrect output.  This affects ``remove_formatting`` too.
-
-``webhelpers.html.grid`` needs some API changes to make a table from a list of
-lists and from a dict. Some arguments will be changing also.
+``webhelpers.html.grid`` needs better docs. The API could maybe use some
+improvement too.
 
 The "unfinished" directory in the WebHelpers source distribution contains
 potential future helpers which are not finished enough for release. These are
 not installed by the installer; they are available only in the source tarball.
 
-Run tests on Python 2.4 to see if any 2.5isms have crept in.
+Port to Python 3.
 
 Too many strip_tags / sanitize / bleach functions.
 
-Finish the third-party page.
-
-Finish the Upgrading page.
-
-Make a high-level changes list based on the beta changelogs.
-
 grid_demo: usage message shows "__main__" rather than package.module.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.