diff options
| author |  Sebastian Spaeth <Sebastian@SSpaeth.de> | 2011-09-29 10:47:28 +0200 |
|---|---|---|
| committer | Sebastian Spaeth <Sebastian@SSpaeth.de> | 2011-09-29 10:47:28 +0200 |
| commit | eb4cd33e6b5406bf69273be52f88a57dad6e8126 (patch) | |
| tree | 89295fb64882df4585924d450f9ce92e56476047 /bindings/python/docs | |
| parent | 0ab5e13e1b12d6ea8e6cbc5df8f30acc00fdfa72 (diff) | |
python: Improve code documentation
1) Fix added .gitignore from commit dc8a1745 to work on the docs folder
2) Improve in-code developer documentation to produce better
sphinx-generated documentation. No code changes.
Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
Diffstat (limited to 'bindings/python/docs')
| -rw-r--r-- | bindings/python/docs/source/index.rst | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/bindings/python/docs/source/index.rst b/bindings/python/docs/source/index.rst index e9f39eb0..d26a0501 100644 --- a/bindings/python/docs/source/index.rst +++ b/bindings/python/docs/source/index.rst @@ -130,7 +130,7 @@ More information on specific topics can be found on the following pages: .. method:: __len__() - .. note:: :meth:`__len__` was removed in version 0.6 as it exhausted + .. warning:: :meth:`__len__` was removed in version 0.6 as it exhausted the iterator and broke list(Messages()). Use the :meth:`Query.count_messages` function or use `len(list(msgs))`. @@ -195,7 +195,12 @@ More information on specific topics can be found on the following pages: .. autoclass:: Tags :members: - .. automethod:: __len__ + .. method:: __len__ + + .. warning:: :meth:`__len__` was removed in version 0.6 as it + exhausted the iterator and broke list(Tags()). Use + :meth:`len(list(msgs))` instead if you need to know the + number of tags. .. automethod:: __str__ |