* **Update:** Updated Project class documentation and included in…

…formation about what is going to be deleted or how the delete operation will be cascaded when a ``Project`` instance is deleted.

CHANGELOG.rst

@@ -19,6 +19,10 @@ Stalker Changes
 * **Fix:** ``Repository`` methods ``is_in_repo`` and ``find_repo`` are now case
   insensitive for Windows paths.
 
+* **Update:** Updated ``Project`` class documentation and included information
+  about what is going to be deleted or how the delete operation will be
+  cascaded when a ``Project`` instance is deleted.
+
 0.2.23
 ======
 

stalker/models/project.py

@@ -124,6 +124,8 @@ class Project(Entity, ReferenceMixin, StatusMixin, DateRangeMixin, CodeMixin):
     To manage all the studio projects at once (schedule them at once please use
     :class:`.Studio`).
 
+    **Repositories**
+
     .. versionadded:: 0.2.13
        Multiple Repositories per Project
 
@@ -136,6 +138,8 @@ class Project(Entity, ReferenceMixin, StatusMixin, DateRangeMixin, CodeMixin):
        Also the :attr:`.repositories` attribute is not a read-only attribute
        anymore.
 
+    **Clients**
+
     .. versionadded:: 0.2.15
        Multiple Clients per Project
 
@@ -144,6 +148,15 @@ class Project(Entity, ReferenceMixin, StatusMixin, DateRangeMixin, CodeMixin):
        by using the :attr:`.ProjectClient.role` attribute of the
        :class:`.ProjectClient` class.
 
+    **Deleting a Project**
+
+    Deleting a :class:`.Project` instance will cascade the delete operation to
+    all the :class:`.Task`\ s related to that particular Project and it will
+    cascade the delete operation to :class:`.TimeLog`\ s, :class:`.Version`\ s,
+    :class:`.Link`\ s and :class:`.Review`\ s etc.. So one can delete a
+    :class:`.Project` instance without worrying about the non-project related
+    data like :class:`.User`\ s or :class:`.Department`\ s to be deleted.
+
     :param clients: The clients which the project is affiliated with. Default
       value is an empty list.