diff --git a/app/vkk/workhours/accounting/announcements/__init__.py b/app/vkk/workhours/accounting/announcements/__init__.py index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..a2bcd7dab31d5c36783ccade3689656554d0e931 100644 --- a/app/vkk/workhours/accounting/announcements/__init__.py +++ b/app/vkk/workhours/accounting/announcements/__init__.py @@ -0,0 +1,3 @@ +""" +This module contains the utilities associated with the management of announcements on the website. +""" \ No newline at end of file diff --git a/app/vkk/workhours/accounting/announcements/urls.py b/app/vkk/workhours/accounting/announcements/urls.py index 5b9af1754724e42b5691e9bb6e9837f8704ff591..73491ae46314dd93d3515bfc66bdd8679a5a208f 100644 --- a/app/vkk/workhours/accounting/announcements/urls.py +++ b/app/vkk/workhours/accounting/announcements/urls.py @@ -1,3 +1,7 @@ +""" +This submodule contains the routing configuration. +""" + from django.urls import path from django.utils.translation import gettext_lazy as _ from ..views import * diff --git a/app/vkk/workhours/accounting/costs/__init__.py b/app/vkk/workhours/accounting/costs/__init__.py index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..d7ad4c06fdfaa53a39a95fc3b46faec66f179893 100644 --- a/app/vkk/workhours/accounting/costs/__init__.py +++ b/app/vkk/workhours/accounting/costs/__init__.py @@ -0,0 +1,3 @@ +""" +This module contains the utilities associated with the management of several costs on the website. +""" \ No newline at end of file diff --git a/app/vkk/workhours/accounting/costs/departments/__init__.py b/app/vkk/workhours/accounting/costs/departments/__init__.py index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..7f421a2c9fe1fe91c048a09bc89da53a47e0f4eb 100644 --- a/app/vkk/workhours/accounting/costs/departments/__init__.py +++ b/app/vkk/workhours/accounting/costs/departments/__init__.py @@ -0,0 +1,3 @@ +""" +This module contains the utilities associated with the management of department costs on the website. +""" \ No newline at end of file diff --git a/app/vkk/workhours/accounting/costs/departments/urls.py b/app/vkk/workhours/accounting/costs/departments/urls.py index 0fdc34be03fe05ba5d66dfeb136f59eab6c102da..04a4093d6d8be576f52f70a8b6af0c5be2899faf 100644 --- a/app/vkk/workhours/accounting/costs/departments/urls.py +++ b/app/vkk/workhours/accounting/costs/departments/urls.py @@ -1,3 +1,7 @@ +""" +This submodule contains the routing configuration. +""" + from django.urls import path, include from django.utils.translation import gettext_lazy as _ from vkk.models import DepartmentDate diff --git a/app/vkk/workhours/accounting/costs/forms.py b/app/vkk/workhours/accounting/costs/forms.py index c1e11ba9a3e0b1cd4bc2bb870f7c67e154a8a77a..b4e33e1179d300b4927a357af074790dcea9e52a 100644 --- a/app/vkk/workhours/accounting/costs/forms.py +++ b/app/vkk/workhours/accounting/costs/forms.py @@ -1,3 +1,7 @@ +""" +A collection of forms used throughout the `costs` module. +""" + from django import forms from vkk.workhours.models import ( GeneralCosts, DepartmentDate, DepartmentCosts, @@ -7,6 +11,9 @@ from vkk.workhours.models import ( from vkk.workhours.forms import CustomDateInput class DepartmentCostForm(forms.ModelForm): + """ + A `ModelForm` subclass for entering `DepartmentCost`s associated to a `DepartmentDate` (model). + """ class Meta: model = DepartmentDate fields = ['date'] @@ -15,6 +22,9 @@ class DepartmentCostForm(forms.ModelForm): } def __init__(self, *args, **kwargs): + """ + Initializes and returns an instance of this class. + """ super().__init__(*args, **kwargs) # Collect all associated departments to create fields @@ -40,6 +50,10 @@ class DepartmentCostForm(forms.ModelForm): ].initial = department_cost_instance.equivalents_per_hour def save(self, commit=True): + """ + Attempts to save the associated data of this object to the database. + Returns the assocaiated `DepartmentDate` instance of this class. + """ # save instance super().save(commit) # save all associated instances @@ -65,6 +79,9 @@ class DepartmentCostForm(forms.ModelForm): return self.instance class SalaryLevelCostForm(forms.ModelForm): + """ + A `ModelForm` subclass for entering `SalaryLevelCosts`s associated to a `SalaryLevelDate` (model). + """ class Meta: model = SalaryLevelDate fields = ['date'] @@ -73,6 +90,9 @@ class SalaryLevelCostForm(forms.ModelForm): } def __init__(self, *args, **kwargs): + """ + Initializes and returns an instance of this class. + """ super().__init__(*args, **kwargs) # Collect all associated departments to create fields @@ -98,6 +118,10 @@ class SalaryLevelCostForm(forms.ModelForm): ].initial = salary_level_cost_instance.brutto_per_hour def save(self, commit=True): + """ + Attempts to save the associated data of this object to the database. + Returns the assocaiated `SalaryLevelDate` instance of this class. + """ # save instance super().save(commit) # save all associated instances diff --git a/app/vkk/workhours/accounting/costs/general/__init__.py b/app/vkk/workhours/accounting/costs/general/__init__.py index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..dbbcea1940a6c9039f9d643f08ba5c02c80d4987 100644 --- a/app/vkk/workhours/accounting/costs/general/__init__.py +++ b/app/vkk/workhours/accounting/costs/general/__init__.py @@ -0,0 +1,3 @@ +""" +This module contains the utilities associated with the management of general costs on the website. +""" \ No newline at end of file diff --git a/app/vkk/workhours/accounting/costs/general/urls.py b/app/vkk/workhours/accounting/costs/general/urls.py index 1a208a21ebba2098f1805111621df200f5764d52..3d346fd3d2158c349e253657f8ee72631abde015 100644 --- a/app/vkk/workhours/accounting/costs/general/urls.py +++ b/app/vkk/workhours/accounting/costs/general/urls.py @@ -1,3 +1,7 @@ +""" +This submodule contains the routing configuration. +""" + from django.urls import path, include from django.utils.translation import gettext_lazy as _ from django.forms import modelform_factory diff --git a/app/vkk/workhours/accounting/costs/receipt_template/__init__.py b/app/vkk/workhours/accounting/costs/receipt_template/__init__.py index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..6b6b359067d4f3e34d16eaade9beb27bff794ad4 100644 --- a/app/vkk/workhours/accounting/costs/receipt_template/__init__.py +++ b/app/vkk/workhours/accounting/costs/receipt_template/__init__.py @@ -0,0 +1,3 @@ +""" +This module contains the utilities associated with the management of receipt templates on the website. +""" \ No newline at end of file diff --git a/app/vkk/workhours/accounting/costs/receipt_template/urls.py b/app/vkk/workhours/accounting/costs/receipt_template/urls.py index f89b7fd51ce561217c5f09fa4e492218be116cc8..548fe8e9b31cf68016887c9831e5c6f10d6add73 100644 --- a/app/vkk/workhours/accounting/costs/receipt_template/urls.py +++ b/app/vkk/workhours/accounting/costs/receipt_template/urls.py @@ -1,3 +1,7 @@ +""" +This submodule contains the routing configuration. +""" + from django.urls import path, include from django.utils.translation import gettext_lazy as _ from django.forms import modelform_factory diff --git a/app/vkk/workhours/accounting/costs/salary_levels/__init__.py b/app/vkk/workhours/accounting/costs/salary_levels/__init__.py index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..9e8697355e8b5faef30f0736631118f322ba1392 100644 --- a/app/vkk/workhours/accounting/costs/salary_levels/__init__.py +++ b/app/vkk/workhours/accounting/costs/salary_levels/__init__.py @@ -0,0 +1,3 @@ +""" +This module contains the utilities associated with the management of salary level costs on the website. +""" \ No newline at end of file diff --git a/app/vkk/workhours/accounting/costs/salary_levels/urls.py b/app/vkk/workhours/accounting/costs/salary_levels/urls.py index 4c70b95fb3c0a0b94bf1b4a84393d59a42185112..987a82e8edcd43a025bce0779a3173e730de26c7 100644 --- a/app/vkk/workhours/accounting/costs/salary_levels/urls.py +++ b/app/vkk/workhours/accounting/costs/salary_levels/urls.py @@ -1,3 +1,7 @@ +""" +This submodule contains the routing configuration. +""" + from django.urls import path, include from django.utils.translation import gettext_lazy as _ from vkk.models import SalaryLevelDate diff --git a/app/vkk/workhours/accounting/costs/urls.py b/app/vkk/workhours/accounting/costs/urls.py index a2e9a0708e708385d55b4ec32d97528fd70dfc83..fbd3de1d09bbf8ed5245ddd422b4ab1547904c7e 100644 --- a/app/vkk/workhours/accounting/costs/urls.py +++ b/app/vkk/workhours/accounting/costs/urls.py @@ -1,3 +1,7 @@ +""" +This submodule contains the routing configuration. +""" + from django.urls import path, include from django.utils.translation import gettext_lazy as _ from ..views import AccountingOverView