tobias/radicale
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Clean a docstring

Browse Source
This commit is contained in:
Guillaume Ayoub 2011-06-05 12:52:24 +02:00
parent 080e4984aa
commit ec9e410659
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
radicale/ical.py
View File

@ -173,11 +173,14 @@ class Calendar(object):
@classmethod @classmethod
def from_path(cls, path, depth="infinite", include_container=True): def from_path(cls, path, depth="infinite", include_container=True):
"""Return a list of calendars and/or sub-items under the given ``path`` """Return a list of calendars and items under the given ``path``.
relative to the storage folder. If ``depth`` is "0", only the actual
object under `path` is returned. Otherwise, also sub-items are appended If ``depth`` is "0", only the actual object under ``path`` is
to the result. If `include_container` is True (the default), the returned. Otherwise, also sub-items are appended to the result. If
containing object is included in the result. ``include_container`` is ``True`` (the default), the containing object
is included in the result.
The ``path`` is relative to the storage folder.
""" """
attributes = posixpath.normpath(path.strip("/")).split("/") attributes = posixpath.normpath(path.strip("/")).split("/")