Revised the documentation to use the term "income and expenses log" instead of "income and expenses", for consistency.

This commit is contained in:
依瑪貓 2023-03-08 07:34:33 +08:00
parent b8b51b34d3
commit e7c43ae390
9 changed files with 20 additions and 20 deletions

View File

@ -52,8 +52,8 @@ class PeriodConverter(BaseConverter):
class IncomeExpensesAccountConverter(BaseConverter):
"""The supplier converter to convert the income and expenses pseudo account
code from and to the corresponding pseudo account in the routes."""
"""The supplier converter to convert the income and expenses log pseudo
account code from and to the corresponding pseudo account in the routes."""
def to_python(self, value: str) -> IncomeExpensesAccount:
"""Converts an account code to an account.

View File

@ -367,9 +367,9 @@ class IncomeExpensesPageParams(PageParams):
def _populate_entries(entries: list[Entry]) -> None:
"""Populates the income and expenses entries with relative data.
"""Populates the income and expenses log entries with relative data.
:param entries: The income and expenses entries.
:param entries: The income and expenses log entries.
:return: None.
"""
transactions: dict[int, Transaction] \

View File

@ -142,10 +142,10 @@ class LedgerPeriodChooser(PeriodChooser):
class IncomeExpensesPeriodChooser(PeriodChooser):
"""The income and expenses period chooser."""
"""The income and expenses log period chooser."""
def __init__(self, currency: Currency, account: IncomeExpensesAccount):
"""Constructs the income and expenses period chooser."""
"""Constructs the income and expenses log period chooser."""
self.currency: Currency = currency
"""The currency."""
self.account: IncomeExpensesAccount = account

View File

@ -104,9 +104,9 @@ class ReportChooser:
@property
def __income_expenses(self) -> OptionLink:
"""Returns the income and expenses.
"""Returns the income and expenses log.
:return: The income and expenses.
:return: The income and expenses log.
"""
account: Account = self.__account
if not re.match(r"[12][12]", account.base_code):
@ -117,7 +117,7 @@ class ReportChooser:
else url_for("accounting.report.income-expenses",
currency=self.__currency, account=account,
period=self.__period)
return OptionLink(gettext("Income and Expenses"), url,
return OptionLink(gettext("Income and Expenses Log"), url,
self.__active_report == ReportType.INCOME_EXPENSES)
@property

View File

@ -27,7 +27,7 @@ class ReportType(Enum):
LEDGER: str = "ledger"
"""The ledger."""
INCOME_EXPENSES: str = "income-expenses"
"""The income and expenses."""
"""The income and expenses log."""
TRIAL_BALANCE: str = "trial-balance"
"""The trial balance."""
INCOME_STATEMENT: str = "income-statement"

View File

@ -115,11 +115,11 @@ def __get_ledger_list(currency: Currency, account: Account, period: Period) \
def get_default_income_expenses_list(currency: Currency,
account: IncomeExpensesAccount) \
-> str | Response:
"""Returns the income and expenses in the default period.
"""Returns the income and expenses log in the default period.
:param currency: The currency.
:param account: The account.
:return: The income and expenses in the default period.
:return: The income and expenses log in the default period.
"""
return __get_income_expenses_list(currency, account, Period.get_instance())
@ -131,12 +131,12 @@ def get_default_income_expenses_list(currency: Currency,
def get_income_expenses_list(currency: Currency,
account: IncomeExpensesAccount,
period: Period) -> str | Response:
"""Returns the income and expenses.
"""Returns the income and expenses log.
:param currency: The currency.
:param account: The account.
:param period: The period.
:return: The income and expenses in the period.
:return: The income and expenses log in the period.
"""
return __get_income_expenses_list(currency, account, period)
@ -144,12 +144,12 @@ def get_income_expenses_list(currency: Currency,
def __get_income_expenses_list(currency: Currency,
account: IncomeExpensesAccount,
period: Period) -> str | Response:
"""Returns the income and expenses.
"""Returns the income and expenses log.
:param currency: The currency.
:param account: The account.
:param period: The period.
:return: The income and expenses in the period.
:return: The income and expenses log in the period.
"""
report: IncomeExpenses = IncomeExpenses(currency, account, period)
if "as" in request.args and request.args["as"] == "csv":

View File

@ -1,6 +1,6 @@
{#
The Mia! Accounting Flask Project
income-expenses-row-desktop.html: The row in the income and expenses for the desktop computers
income-expenses-row-desktop.html: The row in the income and expenses log for the desktop computers
Copyright (c) 2023 imacat.

View File

@ -1,6 +1,6 @@
{#
The Mia! Accounting Flask Project
income-expenses-row-mobile.html: The row in the income and expenses for the mobile devices
income-expenses-row-mobile.html: The row in the income and expenses log for the mobile devices
Copyright (c) 2023 imacat.

View File

@ -1,6 +1,6 @@
{#
The Mia! Accounting Flask Project
income-expenses.html: The income and expenses
income-expenses.html: The income and expenses log
Copyright (c) 2023 imacat.
@ -27,7 +27,7 @@ First written: 2023/3/5
<script src="{{ url_for("accounting.static", filename="js/table-row-link.js") }}"></script>
{% endblock %}
{% block header %}{% block title %}{{ _("Income and Expenses of %(account)s in %(currency)s %(period)s", currency=report.currency.name|title, account=report.account|title, period=report.period.desc|title) }}{% endblock %}{% endblock %}
{% block header %}{% block title %}{{ _("Income and Expenses Log of %(account)s in %(currency)s %(period)s", currency=report.currency.name|title, account=report.account|title, period=report.period.desc|title) }}{% endblock %}{% endblock %}
{% block content %}