Improve documentation

This commit is contained in:
Unrud
2017-06-16 23:16:19 +02:00
parent 0cb6642ec3
commit 070a39a51d
3 changed files with 21 additions and 3 deletions

View File

@ -334,14 +334,14 @@ class BaseCollection:
def discover(cls, path, depth="0"):
"""Discover a list of collections under the given ``path``.
``path`` is sanitized.
If ``depth`` is "0", only the actual object under ``path`` is
returned.
If ``depth`` is anything but "0", it is considered as "1" and direct
children are included in the result.
The ``path`` is relative.
The root collection "/" must always exist.
"""
@ -373,6 +373,8 @@ class BaseCollection:
def create_collection(cls, href, collection=None, props=None):
"""Create a collection.
``href`` is the sanitized path.
If the collection already exists and neither ``collection`` nor
``props`` are set, this method shouldn't do anything. Otherwise the
existing collection must be replaced.