Documentation changes (#61)

flux_sdk/benefits_administration/capabilities/report_employees_hr_data/interface.py

@@ -8,7 +8,9 @@
 
 
 class ReportEmployeesHrData(ABC):
-    """
+    """This capability offers developers a dataset containing personal and employment information for every employee
+    within a company.
+
     This class represents the "report employee data" capability. The developer is supposed to implement
     the following methods in their implementation. 
 
@@ -21,12 +23,13 @@ def format_employees_hr_data(
             config: ReportEmployeesHrDataConfig,
             employee_data: list[EmployeeHrData]
     ) -> File:
-        """
-        This method receives the apps configuration data and a list of employee data.
+        """This hook is for transforming the employee HR data into a file will be sent to the partner company.
+
+        This method receives the app's configuration data and a list of employee data.
         The developer is expected to create a file, formated to their use case, and return that file.
         The file will be tranfered to the partner company via SFTP
 
-        :param ReportEmployeesHrDataConfig:
-        :param list[EmployeeHrData]:
-        :return File:
+        :param config: Employee's HR data configuration
+        :param employee_data: List of employee data
+        :return: File
         """

flux_sdk/flex/capabilities/update_contributions/interface.py

@@ -5,7 +5,9 @@
 
 
 class UpdateContributions(ABC):
-    """
+    """Report employee payroll contributions for contribution types (FSA, HSA, etc.) in a payroll run to a benefit
+     provider.
+
     This class represents the "update contributions" capability. The developer is supposed to implement
     get_formatted_enrollment_files in their implementation. For further details regarding their
     implementation details, check their documentation.
@@ -17,10 +19,12 @@ class UpdateContributions(ABC):
     @abstractmethod
     def get_formatted_contributions_files(company_info: CompanyInfo, employee_contributions: list[EmployeeContribution],
                                           app_context: AppContext) -> list[File]:
-        """
+        """A function that converts employee contributions to formatted contribution file.
+
         This method receives company information and a list of EmployeeContribution objects. The developer is expected
         to return the app specific list of formatted contribution files.
         :param company_info:
         :param employee_contributions:
+        :param app_context:
         :return:
         """

flux_sdk/flex/capabilities/update_enrollments/interface.py

@@ -17,10 +17,12 @@ class UpdateEnrollments(ABC):
     @abstractmethod
     def get_formatted_enrollments_files(company_info: CompanyInfo, employee_enrollments: list[EmployeeEnrollment],
                                         app_context: AppContext) -> list[File]:
-        """
+        """A function that converts employee enrollments to formatted enrollment file.
+
         This method receives company information and a list of EmployeeEnrollment objects. The developer is expected to
         return the app specific list of formatted enrollment files.
         :param company_info:
         :param employee_enrollments:
+        :param app_context:
         :return:
         """