Docstring improvements

Author: einarf

cachetclient/base.py

@@ -46,12 +46,17 @@ def update(self):
             >> updated_resource = resource.update()
 
         Returns:
-            The updated resource from the server
+            Resource: The updated resource from the server
         """
         return self._manager.update(self.get("id"), **self.attrs)
 
     def delete(self) -> None:
-        """Deletes the resource from the server"""
+        """
+        Deletes the resource from the server.
+        
+        Raises:
+            HTTPException if the resource don't exist.
+        """
         self._manager.delete(self.get("id"))
 
     def __repr__(self) -> str:

cachetclient/v1/components.py

@@ -130,18 +130,18 @@ def updated_at(self) -> Optional[datetime]:
     def set_tags(self, names: Iterable[str]):
         """Replace the current tags.
 
-        Note:: We use the provided names also as the slugs.
-               When the resource is returned from the server the next time
-               it will be slugified.
+        .. Note:: We use the provided names also as the slugs.
+                  When the resource is returned from the server the next time
+                  it will be slugified.
         """
         self._data["tags"] = {n: n for n in names}
 
     def add_tags(self, names: Iterable[str]) -> None:
         """Add multiple tags.
 
-        Note:: We use the provided name also as the slug.
-               When the resource is returned from the server the next time
-               it will be slugified.
+        .. Note:: We use the provided name also as the slug.
+                  When the resource is returned from the server the next time
+                  it will be slugified.
 
         Args:
             names (Iterable[str]): Iterable with names such as a list or set
@@ -152,9 +152,9 @@ def add_tags(self, names: Iterable[str]) -> None:
     def add_tag(self, name: str) -> None:
         """Add a new tag.
 
-        Note: We use the provided name also as the slug.
-        When the resource is returned from the server the next time
-        it will be slugified.
+        .. Note: We use the provided name also as the slug.
+                 When the resource is returned from the server the next time
+                 it will be slugified.
 
         Args:
             name (str): Name of the tag
@@ -190,8 +190,8 @@ def has_tag(self, name: str = None, slug: str = None) -> bool:
         Tags and slugs are case insensitive.
 
         Args:
-            name (str): Tag name
-            slug (str): Slug name
+            name (str): Name of the tag
+            slug (str): Slug for the tag
 
         Returns:
             bool: If the tag exists
@@ -218,7 +218,7 @@ def update(self):
             >> updated_resource = resource.update()
 
         Returns:
-            The updated resource from the server
+            Resource: The updated resource from the server
         """
         # Transform tags into an iterable
         data = copy.deepcopy(self.attrs)