feat: impl docs (#4)

The entire public api is covered with documentation in two languages - Russian and English.

the library now supports the latest three versions of python - 3.12, 3.13 and 3.14

minor design changes: now, when a Boolean flag is entered, its value is an empty string, not None.

tests have been adapted to the supported versions of python, readmi has been redesigned in two languages, German is no longer available.
This commit is contained in:
kolo
2025-12-04 21:55:19 +03:00
committed by GitHub
parent a2ac6a608f
commit ce7e24b924
210 changed files with 13770 additions and 1183 deletions
@@ -0,0 +1,172 @@
# SOME DESCRIPTIVE TITLE.
# Copyright (C) 2025, kolo
# This file is distributed under the same license as the Argenta package.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2025.
#
msgid ""
msgstr ""
"Project-Id-Version: Argenta \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2025-12-02 22:27+0300\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: en\n"
"Language-Team: en <LL@li.org>\n"
"Plural-Forms: nplurals=2; plural=(n != 1);\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=utf-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.17.0\n"
#: ../../root/api/command/flags.rst:4
msgid "Flags"
msgstr "Flags"
#: ../../root/api/command/flags.rst:6
msgid ""
"``Flags`` — это коллекция флагов команды. Её основная задача — "
"группировать и управлять набором флагов, зарегистрированных для "
"конкретной команды. ``Flags`` служит контейнером, который позволяет "
"удобно добавлять, извлекать, итерировать флаги и проверять их наличие."
msgstr ""
"``Flags`` is a collection of command flags. Its main purpose is to group and manage "
"the set of flags registered for a specific command. ``Flags`` serves as a container "
"that allows convenient addition, retrieval, iteration of flags, and checking their presence."
#: ../../root/api/command/flags.rst:10
msgid ""
"Документация по отдельным флагам (:ref:`Flag <root_api_command_flag>`, "
":ref:`InputFlag <root_api_command_input_flag>`)"
msgstr ""
"Documentation for individual flags (:ref:`Flag <root_api_command_flag>`, "
":ref:`InputFlag <root_api_command_input_flag>`)"
#: ../../root/api/command/flags.rst:12
msgid ""
"Документация по :ref:`InputFlags <root_api_command_input_flags>` — "
"коллекция обработанных флагов, введённых пользователем."
msgstr ""
"Documentation for :ref:`InputFlags <root_api_command_input_flags>` — "
"a collection of processed flags entered by the user."
#: ../../root/api/command/flags.rst:14
msgid ""
":ref:`Общая информация <root_flags>` о флагах и их использовании в "
"приложении ``Argenta``"
msgstr ""
":ref:`General information <root_flags>` about flags and their usage in "
"the ``Argenta`` application"
#: ../../root/api/command/flags.rst:19
msgid "Инициализация"
msgstr "Initialization"
#: ../../root/api/command/flags.rst:26
msgid "Создаёт новую коллекцию флагов."
msgstr "Creates a new flag collection."
#: ../../root/api/command/flags.rst:28
msgid ""
"``flags``: Необязательный список флагов типа ``Flag`` для инициализации "
"коллекции. Если не указан, создаётся пустая коллекция."
msgstr ""
"``flags``: Optional list of flags of type ``Flag`` for initializing the collection. "
"If not specified, an empty collection is created."
#: ../../root/api/command/flags.rst:30
msgid "**Атрибуты:**"
msgstr "**Attributes:**"
#: ../../root/api/command/flags.rst:35
msgid "Список всех зарегистрированных флагов типа ``Flag``."
msgstr "List of all registered flags of type ``Flag``."
#: ../../root/api/command/flags.rst:37 ../../root/api/command/flags.rst:63
#: ../../root/api/command/flags.rst:86 ../../root/api/command/flags.rst:109
msgid "**Пример использования:**"
msgstr "**Usage example:**"
#: ../../root/api/command/flags.rst:46
msgid "Методы"
msgstr "Methods"
#: ../../root/api/command/flags.rst:49
msgid "add_flag"
msgstr ""
#: ../../root/api/command/flags.rst:56
msgid "Добавляет флаг в коллекцию."
msgstr "Adds a flag to the collection."
#: ../../root/api/command/flags.rst
msgid "param flag"
msgstr "param flag"
#: ../../root/api/command/flags.rst:58
msgid "Флаг типа ``Flag`` для добавления."
msgstr "Flag of type ``Flag`` to add."
#: ../../root/api/command/flags.rst
msgid "return"
msgstr "return"
#: ../../root/api/command/flags.rst:59 ../../root/api/command/flags.rst:82
msgid "None."
msgstr "None."
#: ../../root/api/command/flags.rst:61
msgid "Используется для динамического расширения набора флагов."
msgstr "Used for dynamically extending the set of flags."
#: ../../root/api/command/flags.rst:72
msgid "add_flags"
msgstr ""
#: ../../root/api/command/flags.rst:79
msgid "Добавляет в коллекцию список флагов."
msgstr "Adds a list of flags to the collection."
#: ../../root/api/command/flags.rst
msgid "param flags"
msgstr "param flags"
#: ../../root/api/command/flags.rst:81
msgid "Список флагов типа ``Flag`` для добавления."
msgstr "List of flags of type ``Flag`` to add."
#: ../../root/api/command/flags.rst:84
msgid ""
"Метод расширяет коллекцию, добавляя в неё все флаги из переданного "
"списка. Эффективен для пакетного добавления."
msgstr ""
"The method extends the collection by adding all flags from the provided list. "
"Efficient for batch addition."
#: ../../root/api/command/flags.rst:95
msgid "get_flag_by_name"
msgstr ""
#: ../../root/api/command/flags.rst:102
msgid "Возвращает флаг по имени."
msgstr "Returns a flag by name."
#: ../../root/api/command/flags.rst
msgid "param name"
msgstr "param name"
#: ../../root/api/command/flags.rst:104
msgid "Имя искомого флага."
msgstr "Name of the flag to search for."
#: ../../root/api/command/flags.rst:105
msgid "Объект ``Flag`` или ``None``, если флаг не найден."
msgstr "``Flag`` object or ``None`` if the flag is not found."
#: ../../root/api/command/flags.rst:107
msgid ""
"Метод возвращает флаг с соответствующим именем. Если флаг не найден, "
"возвращается ``None``."
msgstr ""
"The method returns a flag with the corresponding name. If the flag is not found, "
"``None`` is returned."