Improve doc string
This commit is contained in:
parent
d2811b7fa5
commit
ae4c8a0bd1
@ -122,10 +122,13 @@ def check_and_sanitize_item(vobject_item, is_collection=False, uid=None,
|
|||||||
tag=None):
|
tag=None):
|
||||||
"""Check vobject items for common errors and add missing UIDs.
|
"""Check vobject items for common errors and add missing UIDs.
|
||||||
|
|
||||||
``multiple`` indicates that the vobject_item contains unrelated components.
|
``is_collection`` indicates that vobject_item contains unrelated
|
||||||
|
components.
|
||||||
|
|
||||||
If ``uid`` is not set, the UID is generated randomly.
|
If ``uid`` is not set, the UID is generated randomly.
|
||||||
|
|
||||||
|
The ``tag`` of the collection.
|
||||||
|
|
||||||
"""
|
"""
|
||||||
if tag and tag not in ("VCALENDAR", "VADDRESSBOOK"):
|
if tag and tag not in ("VCALENDAR", "VADDRESSBOOK"):
|
||||||
raise ValueError("Unsupported collection tag: %r" % tag)
|
raise ValueError("Unsupported collection tag: %r" % tag)
|
||||||
|
Loading…
Reference in New Issue
Block a user