Fix and add missing docstrings (#22)

Author: ebram96

src/abstract_api/avatars/avatars.py

@@ -48,9 +48,9 @@ def create(
                 The characters will first be chosen from distinct words, then
                 from the second letter of distinct words.
             background_color: The hex color for the background.
-                It defaults to #335eea.  TODO: Remove # from prefix.
+                It defaults to #335eea.
             font_color: The hex color for the font.
-                It defaults to white, i.e.,ffffff.  TODO: Remove # from prefix.
+                It defaults to white, i.e.,ffffff.
             is_rounded: Create a rounded avatar picture instead of squared one.
                 It defaults to false.
             is_uppercase: Set the initials in the avatar to all capitals.

src/abstract_api/avatars/avatars_response.py

@@ -2,4 +2,4 @@
 
 
 class AvatarsResponse(FileResponse):
-    """TODO."""
+    """Avatars service response."""

src/abstract_api/company_enrichment/company_enrichment.py

@@ -16,6 +16,7 @@ class CompanyEnrichment(
 
     Attributes:
         _subdomain: Company enrichment service subdomain.
+        _response_fields: API response fields.
     """
     _subdomain = "companyenrichment"
     _response_fields = RESPONSE_FIELDS
@@ -28,7 +29,7 @@ def check(
         """Finds a company's details using its domain.
 
         Args:
-            domain: The domain of the company you want to get data from.
+            domain: The domain of the company you want to get data for.
             fields: Selected response fields (optional).
 
         Returns:

src/abstract_api/company_enrichment/company_enrichment_response.py

@@ -31,7 +31,7 @@ def employees_count(self) -> str | None:
 
     @property
     def locality(self) -> str | None:
-        """The city or region he company headquarter is based in."""
+        """The city or region the company headquarter is based in."""
         return self._get_response_field("locality")
 
     @property

src/abstract_api/core/bases/_base_response.py

@@ -5,7 +5,7 @@
 
 
 class BaseResponseMeta(ABC):
-    """Base response meta data for Abstract API service response."""
+    """Base response metadata for Abstract API service response."""
 
     def __init__(self, response: requests.models.Response) -> None:
         """Initialize a new ResponseMeta."""
@@ -27,7 +27,7 @@ class BaseResponse(ABC):
     """Base Abstract API service response.
 
     Attributes:
-        _meta_class: Class (type) of meta.
+        _meta_class: Class (type) of response metadata instance.
     """
     _meta_class: ClassVar[Type[BaseResponseMeta]]
 
@@ -37,5 +37,5 @@ def __init__(self, response: requests.models.Response) -> None:
 
     @property
     def meta(self) -> BaseResponseMeta:
-        """Meta data about response."""
+        """Metadata about response."""
         return self._meta

src/abstract_api/core/bases/base_service.py

@@ -70,7 +70,7 @@ def _service_request(
                 endpoints.
 
         Returns:
-            AbstractAPI's response.
+            Parsed AbstractAPI's response.
         """
         if _method.lower() not in ["get", "post"]:
             raise ClientRequestError(

src/abstract_api/core/bases/file_response.py

@@ -6,16 +6,16 @@
 
 
 class FileResponseMeta(BaseResponseMeta):
-    """TODO."""
+    """Meta data about a file-based API response."""
 
 
 class FileResponse(BaseResponse):
-    """TODO."""
+    """File-based API response."""
     _meta_class: ClassVar[Type[FileResponseMeta]] = FileResponseMeta
     meta: FileResponseMeta
 
     def __init__(self, response: requests.models.Response) -> None:
-        """Initialize a new ResponseMeta."""
+        """Initialize a new FileResponse."""
         super().__init__(response)
         self._content: bytes = response.content
 

src/abstract_api/core/bases/json_response.py

@@ -6,7 +6,7 @@
 
 
 class JSONResponseMeta(BaseResponseMeta):
-    """TODO."""
+    """Metadata about a JSON-based API response."""
 
     def __init__(self, response: requests.models.Response) -> None:
         """Initialize a new JSONResponseMeta."""
@@ -23,13 +23,21 @@ def body_json(self) -> dict[str, Any] | list[dict[str, Any]]:
 
 
 class JSONResponse(BaseResponse):
-    """TODO."""
+    """JSON-based API response."""
     _response_fields: frozenset[str]
     _meta_class: ClassVar[Type[JSONResponseMeta]] = JSONResponseMeta
     meta: JSONResponseMeta
 
     def _init_response_field(self, field: str, value: Any) -> None:
-        """TODO."""
+        """Sets a response field's value during instance initialization.
+
+        This should be used in/as a part of __init__ method.
+
+        Args:
+            field: Field name.
+            value: Value to be set. The value is parsed to a nested entity
+                if the field is a nested entity.
+        """
         setattr(self, f"_{field}", value)
 
     def __init__(
@@ -38,7 +46,7 @@ def __init__(
         response_fields: frozenset[str],
         list_response: bool = False
     ) -> None:
-        """TODO."""
+        """Initialize a new JSONResponse."""
         super().__init__(response)
         self._response_fields = response_fields
 

src/abstract_api/core/exceptions/api_request_error.py

@@ -6,7 +6,7 @@
 
 
 class APIRequestError(AbstractAPIException):
-    """Raised when there's after making an API request."""
+    """Raised when there's a problem with returned in API response."""
     def __init__(
         self,
         http_status: int,

src/abstract_api/core/exceptions/client_request_error.py

@@ -2,4 +2,4 @@
 
 
 class ClientRequestError(AbstractAPIException):
-    """Raised when there's a problem on our side before making API request."""
+    """Raised when there's a problem before making API request."""