]> git.ipfire.org Git - thirdparty/babel.git/commitdiff
Added messages docs
authorArmin Ronacher <armin.ronacher@active-4.com>
Thu, 25 Jul 2013 21:22:44 +0000 (23:22 +0200)
committerArmin Ronacher <armin.ronacher@active-4.com>
Thu, 25 Jul 2013 21:22:44 +0000 (23:22 +0200)
docs/api/index.rst
docs/api/messages.rst [new file with mode: 0644]

index 9222cf1cb23821c7d84db9fcb977035d00aea820..208d4decc84d39987ad5ecdd81a39be0f3fb3add 100644 (file)
@@ -9,6 +9,7 @@ public API of Babel.
 
    core
    dates
+   messages
    numbers
    plural
    support
diff --git a/docs/api/messages.rst b/docs/api/messages.rst
new file mode 100644 (file)
index 0000000..aed231e
--- /dev/null
@@ -0,0 +1,23 @@
+Messages and Catalogs
+=====================
+
+.. module:: babel.messages
+
+Babel provides functionality to work with message catalogs.  There is more
+functionality than that available but some of it is currently only
+documented in the sourcecode as we have to decide what part of the API
+will become public and what should stay internal.
+
+Basic Interface
+---------------
+
+.. autoclass:: Message
+   :members:
+
+.. autoclass:: Catalog
+   :members:
+
+Exceptions
+----------
+
+.. autoexception:: TranslationError