python: Improve the docstring of Database.get_directory

Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
This commit is contained in:
Justus Winter 2012-02-22 20:46:42 +01:00
parent 92983dd14e
commit 35ceaf496f

View file

@ -345,10 +345,8 @@ class Database(object):
of database (see :meth:`get_path`), or else should be an absolute
path with initial components that match the path of 'database'.
:returns: :class:`Directory` or raises an exception.
:raises:
:exc:`NotmuchError` with :attr:`STATUS`.FILE_ERROR
If path is not relative database or absolute with initial
components same as database.
:raises: :exc:`FileError` if path is not relative database or absolute
with initial components same as database.
"""
self._assert_db_is_initialized()
# sanity checking if path is valid, and make path absolute