Revised the documentation of the CurrentAccount data model.

This commit is contained in:
依瑪貓 2023-03-22 21:36:07 +08:00
parent 979eea606a
commit 7755365467

View File

@ -14,7 +14,7 @@
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # limitations under the License.
"""The current account. """The current assets and liabilities account.
""" """
import typing as t import typing as t
@ -26,14 +26,14 @@ import sqlalchemy as sa
class CurrentAccount: class CurrentAccount:
"""The current account.""" """A current assets and liabilities account."""
CURRENT_AL_CODE: str = "0000-000" CURRENT_AL_CODE: str = "0000-000"
"""The account code for the current assets and liabilities.""" """The account code for all current assets and liabilities."""
def __init__(self, account: Account | None = None): def __init__(self, account: Account | None = None):
"""Constructs the current account. """Constructs the current assets and liabilities account.
:param account: The account. :param account: The actual account.
""" """
self.account: Account | None = account self.account: Account | None = account
"""The actual account.""" """The actual account."""
@ -55,9 +55,9 @@ class CurrentAccount:
@classmethod @classmethod
def current_assets_and_liabilities(cls) -> t.Self: def current_assets_and_liabilities(cls) -> t.Self:
"""Returns the pseudo account for current assets and liabilities. """Returns the pseudo account for all current assets and liabilities.
:return: The pseudo account for current assets and liabilities. :return: The pseudo account for all current assets and liabilities.
""" """
account: cls = cls() account: cls = cls()
account.id = 0 account.id = 0