docs: contact docstrings

Issue: #13

src/contact/config.py

@@ -1,7 +1,3 @@
 """
-Configurations for contact module
+Configurations for the contact module
-
-Configurations:
- - List: Description
- - Configs: Description
 """

src/contact/constants.py

@@ -1,7 +1,3 @@
 """
-Constants and error codes for contact module
+Constants for the contact module
-
-Constants:
- - List: Description
- - Consts: Description
 """

src/contact/dependencies.py

@@ -1,11 +1,3 @@
 """
-Router dependencies for contact module
+Dependencies for the contact module
-
-Classes:
- - List: Description
- - Classes: Description
-
-Functions:
- - List: Description
- - Functions: Description
 """

src/contact/exceptions.py

@@ -1,9 +1,8 @@
 """
-Module specific exceptions for contact module
+Exceptions related to the contact module
 
-Exceptions:
+Exports:
- - List: Description
+ - ContactNotFoundException: Takes an optional contact ID int
- - Exceptions: Description
 """
 from typing import Optional
 

src/contact/models.py

@@ -1,9 +1,9 @@
 """
-Database models for contact module
+Database models for the contact module
 
 Models:
  - Contact: id[pk], email, first_name, last_name, phonenumber, vat_number
-            street_address, post_office_box_number, address_locality, country_code, address_region, postal_code
+            street_address, street_address_line_2, post_office_box_number, address_locality, country_code, address_region, postal_code
 """
 from sqlalchemy import Column, Integer, String, ForeignKey
 

src/contact/router.py

@@ -1,13 +1,5 @@
 """
-Router endpoints for contact module
+Router endpoints for the contact module
-
-Endpoints:
- - [get]/{contact_id} - Returns non-address type details for contact
- - [get]/{contact_id}/address - Returns address details for contact
- - [get]/{contact_id}/orgs - Returns a list of orgs which the contact is assigned to, and what they are assigned as
- - [post]/ - Creates a new contact
- - [patch]/{contact_id} - Updates the details of an existing contact
- - [delete]/{contact_id} - Deletes a contact by ID
 """
 from fastapi import APIRouter
 

src/contact/schemas.py

@@ -1,9 +1,9 @@
 """
-Pydantic models for contact module
+Pydantic models for the contact module
 
 Models:
- - List: Description
+ - ContactAddress
- - Models: Description
+ - ContactModel: Contains ContactAddress as a property
 """
 from typing import Optional
 

src/contact/service.py

@@ -1,11 +1,3 @@
 """
-Module specific business logic for contact module
+Module specific business logic for the contact module
-
-Classes:
- - List: Description
- - Classes: Description
-
-Functions:
- - List: Description
- - Functions: Description
 """

src/contact/utils.py

@@ -1,11 +1,3 @@
 """
-Non-business logic reusable functions and classes for contact module
+Non-business logic reusable functions and classes for the contact module
-
-Classes:
- - List: Description
- - Classes: Description
-
-Functions:
- - List: Description
- - Functions: Description
 """