From e09d33f3eef77368b8c8c2b6decb276957d5aad9 Mon Sep 17 00:00:00 2001
From: Unrud <unrud@openaliasbox.org>
Date: Fri, 9 Jun 2017 02:31:03 +0200
Subject: [PATCH] Document properties of BaseCollection

---
 radicale/storage.py | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/radicale/storage.py b/radicale/storage.py
index 7162106..11c8e01 100644
--- a/radicale/storage.py
+++ b/radicale/storage.py
@@ -322,6 +322,15 @@ class BaseCollection:
     configuration = None
     logger = None
 
+    # Properties of instance
+    """The sanitized path of the collection without leading or trailing ``/``.
+    """
+    path = ""
+    """The owner of the collection. (``path.split("/", maxsplit=1)[0]``)"""
+    owner = ""
+    """Collection is a principal. (``bool(path) and "/" not in path``)"""
+    is_principal = False
+
     @classmethod
     def discover(cls, path, depth="0"):
         """Discover a list of collections under the given ``path``.