From 11ab4a4ba6eed608ec4c14b6e6d37854ae551e86 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E4=BE=9D=E7=91=AA=E8=B2=93?= Date: Wed, 8 Mar 2023 17:21:14 +0800 Subject: [PATCH] Revised the documentation of the CSV rows for the reports. --- src/accounting/report/reports/balance_sheet.py | 8 ++++---- src/accounting/report/reports/income_expenses.py | 4 ++-- src/accounting/report/reports/income_statement.py | 4 ++-- src/accounting/report/reports/journal.py | 4 ++-- src/accounting/report/reports/ledger.py | 4 ++-- src/accounting/report/reports/search.py | 4 ++-- src/accounting/report/reports/trial_balance.py | 4 ++-- 7 files changed, 16 insertions(+), 16 deletions(-) diff --git a/src/accounting/report/reports/balance_sheet.py b/src/accounting/report/reports/balance_sheet.py index e1d5c1a..f795ce6 100644 --- a/src/accounting/report/reports/balance_sheet.py +++ b/src/accounting/report/reports/balance_sheet.py @@ -259,10 +259,10 @@ class AccountCollector: class CSVHalfRow: - """A half row in the CSV balance sheet.""" + """A half row in the CSV.""" def __init__(self, title: str | None, amount: Decimal | None): - """The constructs a half row in the CSV balance sheet. + """The constructs a half row in the CSV. :param title: The title. :param amount: The amount. @@ -274,10 +274,10 @@ class CSVHalfRow: class CSVRow(BaseCSVRow): - """A row in the CSV balance sheet.""" + """A row in the CSV.""" def __init__(self): - """Constructs a row in the CSV balance sheet.""" + """Constructs a row in the CSV.""" self.asset_title: str | None = None """The title of the asset.""" self.asset_amount: Decimal | None = None diff --git a/src/accounting/report/reports/income_expenses.py b/src/accounting/report/reports/income_expenses.py index fb1d7f2..8d3b7a6 100644 --- a/src/accounting/report/reports/income_expenses.py +++ b/src/accounting/report/reports/income_expenses.py @@ -202,7 +202,7 @@ class EntryCollector: class CSVRow(BaseCSVRow): - """A row in the CSV income and expenses log.""" + """A row in the CSV.""" def __init__(self, txn_date: date | str | None, account: str | None, @@ -211,7 +211,7 @@ class CSVRow(BaseCSVRow): expense: str | Decimal | None, balance: str | Decimal | None, note: str | None): - """Constructs a row in the CSV income and expenses log. + """Constructs a row in the CSV. :param txn_date: The transaction date. :param account: The account. diff --git a/src/accounting/report/reports/income_statement.py b/src/accounting/report/reports/income_statement.py index 0ac5464..d7524a3 100644 --- a/src/accounting/report/reports/income_statement.py +++ b/src/accounting/report/reports/income_statement.py @@ -116,10 +116,10 @@ class IncomeStatementSection: class CSVRow(BaseCSVRow): - """A row in the CSV income statement.""" + """A row in the CSV.""" def __init__(self, text: str | None, amount: str | Decimal | None): - """Constructs a row in the CSV income statement. + """Constructs a row in the CSV. :param text: The text. :param amount: The amount. diff --git a/src/accounting/report/reports/journal.py b/src/accounting/report/reports/journal.py index 32a70b1..bcafcc3 100644 --- a/src/accounting/report/reports/journal.py +++ b/src/accounting/report/reports/journal.py @@ -71,7 +71,7 @@ class Entry: class CSVRow(BaseCSVRow): - """A row in the CSV journal.""" + """A row in the CSV.""" def __init__(self, txn_date: str | date, currency: str, @@ -80,7 +80,7 @@ class CSVRow(BaseCSVRow): debit: str | Decimal | None, credit: str | Decimal | None, note: str | None): - """Constructs a row in the CSV journal. + """Constructs a row in the CSV. :param txn_date: The transaction date. :param summary: The summary. diff --git a/src/accounting/report/reports/ledger.py b/src/accounting/report/reports/ledger.py index 5b91e94..2dc9bfe 100644 --- a/src/accounting/report/reports/ledger.py +++ b/src/accounting/report/reports/ledger.py @@ -183,7 +183,7 @@ class EntryCollector: class CSVRow(BaseCSVRow): - """A row in the CSV ledger.""" + """A row in the CSV.""" def __init__(self, txn_date: date | str | None, summary: str | None, @@ -191,7 +191,7 @@ class CSVRow(BaseCSVRow): credit: str | Decimal | None, balance: str | Decimal | None, note: str | None): - """Constructs a row in the CSV ledger. + """Constructs a row in the CSV. :param txn_date: The transaction date. :param summary: The summary. diff --git a/src/accounting/report/reports/search.py b/src/accounting/report/reports/search.py index e74d969..94b387c 100644 --- a/src/accounting/report/reports/search.py +++ b/src/accounting/report/reports/search.py @@ -70,7 +70,7 @@ class Entry: class CSVRow(BaseCSVRow): - """A row in the CSV search result.""" + """A row in the CSV.""" def __init__(self, txn_date: str | date, currency: str, @@ -79,7 +79,7 @@ class CSVRow(BaseCSVRow): debit: str | Decimal | None, credit: str | Decimal | None, note: str | None): - """Constructs a row in the CSV search result. + """Constructs a row in the CSV. :param txn_date: The transaction date. :param summary: The summary. diff --git a/src/accounting/report/reports/trial_balance.py b/src/accounting/report/reports/trial_balance.py index ac93118..0b086e9 100644 --- a/src/accounting/report/reports/trial_balance.py +++ b/src/accounting/report/reports/trial_balance.py @@ -71,12 +71,12 @@ class TrialBalanceTotal: class CSVRow(BaseCSVRow): - """A row in the CSV trial balance.""" + """A row in the CSV.""" def __init__(self, text: str | None, debit: str | Decimal | None, credit: str | Decimal | None): - """Constructs a row in the CSV trial balance. + """Constructs a row in the CSV. :param text: The text. :param debit: The debit amount.