Update documentation

This commit is contained in:
2025-12-03 13:51:49 +03:00
parent 2800a7ffc2
commit cd3095f42e
4 changed files with 244 additions and 163 deletions
+142 -121
View File
@@ -3,12 +3,11 @@
# This file is distributed under the same license as the Argenta package.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2025.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: Argenta \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2025-12-02 22:27+0300\n"
"POT-Creation-Date: 2025-12-03 13:42+0300\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: en\n"
@@ -34,17 +33,18 @@ msgid ""
"процесс более гладким для всех. Сообщество с нетерпением ждёт ваших идей!"
" 🎉"
msgstr ""
"We welcome and appreciate any contribution. Please read the relevant section "
"before getting started. This will make it easier for maintainers and make the "
"process smoother for everyone. The community is looking forward to your ideas! 🎉"
"We welcome and appreciate any contribution. Please read the relevant "
"section before getting started. This will make it easier for maintainers "
"and make the process smoother for everyone. The community is looking "
"forward to your ideas! 🎉"
#: ../../root/contributing.rst:14
msgid ""
"Если вам нравится проект, но у вас нет времени на активный вклад, вы "
"можете поддержать нас другими способами:"
msgstr ""
"If you like the project but don't have time to actively contribute, you can "
"support us in other ways:"
"If you like the project but don't have time to actively contribute, you "
"can support us in other ways:"
#: ../../root/contributing.rst:16
msgid "Поставить звезду на GitHub."
@@ -60,47 +60,49 @@ msgstr "Reference the project in your repository's `README`."
#: ../../root/contributing.rst:19
msgid "Упомянуть проект на митапах и рассказать о нём друзьям и коллегам."
msgstr "Mention the project at meetups and tell your friends and colleagues about it."
msgstr ""
"Mention the project at meetups and tell your friends and colleagues about"
" it."
#: ../../root/contributing.rst:24
msgid "Содержание"
msgstr "Contents"
#: ../../root/contributing.rst:26
msgid "`Кодекс поведения`_"
msgstr "`Code of Conduct`_"
msgid ":ref:`Кодекс поведения <code-of-conduct>`"
msgstr ":ref:`Code of Conduct <code-of-conduct>`"
#: ../../root/contributing.rst:27
msgid "`У меня есть вопрос`_"
msgstr "`I Have a Question`_"
msgid ":ref:`У меня есть вопрос <i-have-a-question>`"
msgstr ":ref:`I Have a Question <i-have-a-question>`"
#: ../../root/contributing.rst:28
msgid "`Я хочу внести вклад`_"
msgstr "`I Want to Contribute`_"
msgid ":ref:`Я хочу внести вклад <i-want-to-contribute>`"
msgstr ":ref:`I Want to Contribute <i-want-to-contribute>`"
#: ../../root/contributing.rst:29
msgid "`Сообщение об ошибках`_"
msgstr "`Reporting Bugs`_"
msgid ":ref:`Сообщение об ошибках <reporting-bugs>`"
msgstr ":ref:`Reporting Bugs <reporting-bugs>`"
#: ../../root/contributing.rst:30
msgid "`Предложение улучшений`_"
msgstr "`Suggesting Enhancements`_"
msgid ":ref:`Предложение улучшений <suggesting-enhancements>`"
msgstr ":ref:`Suggesting Enhancements <suggesting-enhancements>`"
#: ../../root/contributing.rst:31
msgid "`Ваш первый вклад в код`_"
msgstr "`Your First Code Contribution`_"
msgid ":ref:`Ваш первый вклад в код <your-first-code-contribution>`"
msgstr ":ref:`Your First Code Contribution <your-first-code-contribution>`"
#: ../../root/contributing.rst:32
msgid "`Улучшение документации`_"
msgstr "`Improving Documentation`_"
msgid ":ref:`Улучшение документации <improving-documentation>`"
msgstr ":ref:`Improving Documentation <improving-documentation>`"
#: ../../root/contributing.rst:33
msgid "`Руководства по стилю`_"
msgstr "`Style Guides`_"
msgid ":ref:`Руководства по стилю <styleguide>`"
msgstr ":ref:`Style Guides <styleguide>`"
#: ../../root/contributing.rst:34
msgid "`Присоединяйтесь к команде проекта`_"
msgstr "`Join the Project Team`_"
msgid ":ref:`Присоединяйтесь к команде проекта <join-the-project-team>`"
msgstr ":ref:`Join the Project Team <join-the-project-team>`"
#: ../../root/contributing.rst:39
msgid "Кодекс поведения"
@@ -112,9 +114,9 @@ msgid ""
"Argenta <root_code_of_conduct>`. Участвуя, вы обязуетесь соблюдать этот "
"кодекс. Пожалуйста, сообщайте о недопустимом поведении."
msgstr ""
"This project and all its participants are governed by the :ref:`Argenta Code of "
"Conduct <root_code_of_conduct>`. By participating, you are expected to uphold "
"this code. Please report unacceptable behavior."
"This project and all its participants are governed by the :ref:`Argenta "
"Code of Conduct <root_code_of_conduct>`. By participating, you are "
"expected to uphold this code. Please report unacceptable behavior."
#: ../../root/contributing.rst:49
msgid "У меня есть вопрос"
@@ -136,9 +138,9 @@ msgid ""
"Также рекомендуем поискать ответ в интернете."
msgstr ""
"Search for an answer in existing `Issues "
"<https://github.com/koloideal/Argenta/issues>`_. If you found a similar question "
"but still need clarification, you can comment on it. We also recommend searching "
"the internet for an answer."
"<https://github.com/koloideal/Argenta/issues>`_. If you found a similar "
"question but still need clarification, you can comment on it. We also "
"recommend searching the internet for an answer."
#: ../../root/contributing.rst:57
msgid ""
@@ -147,8 +149,8 @@ msgid ""
"можно больше контекста, включая версии проекта и платформы."
msgstr ""
"If you can't find an answer, create a new `Issue "
"<https://github.com/koloideal/Argenta/issues/new>`_ and provide as much context "
"as possible, including project and platform versions."
"<https://github.com/koloideal/Argenta/issues/new>`_ and provide as much "
"context as possible, including project and platform versions."
#: ../../root/contributing.rst:59
msgid "Мы займемся вашей задачей как можно скорее."
@@ -168,9 +170,9 @@ msgid ""
"контента, обладаете необходимыми правами на него и соглашаетесь, что он "
"может распространяться под лицензией проекта."
msgstr ""
"By contributing to this project, you confirm that you are the author of 100% of "
"the content, have the necessary rights to it, and agree that it may be distributed "
"under the project's license."
"By contributing to this project, you confirm that you are the author of "
"100% of the content, have the necessary rights to it, and agree that it "
"may be distributed under the project's license."
#: ../../root/contributing.rst:77
msgid "Сообщение об ошибках"
@@ -187,9 +189,10 @@ msgid ""
"информацию и подробно опишите проблему. Это поможет нам исправить её как "
"можно быстрее."
msgstr ""
"A good bug report shouldn't require others to extract additional information from "
"you. Please investigate thoroughly, gather information, and describe the problem "
"in detail. This will help us fix it as quickly as possible."
"A good bug report shouldn't require others to extract additional "
"information from you. Please investigate thoroughly, gather information, "
"and describe the problem in detail. This will help us fix it as quickly "
"as possible."
#: ../../root/contributing.rst:83 ../../root/contributing.rst:124
msgid "Убедитесь, что вы используете последнюю версию."
@@ -200,12 +203,12 @@ msgid ""
"Убедитесь, что проблема действительно является ошибкой, а не вызвана, "
"например, использованием несовместимых версий окружения. Прочтите "
"`документацию <https://argenta.readthedocs.io>`_ и, если нужна поддержка,"
" загляните в раздел `У меня есть вопрос`_."
" загляните в раздел :ref:`У меня есть вопрос <i-have-a-question>`."
msgstr ""
"Make sure the issue is actually a bug and not caused by, for example, using "
"incompatible environment versions. Read the `documentation "
"<https://argenta.readthedocs.io>`_ and, if you need support, check out the "
"`I Have a Question`_ section."
"Make sure the issue is actually a bug and not caused by, for example, "
"using incompatible environment versions. Read the `documentation "
"<https://argenta.readthedocs.io>`_ and, if you need support, check out "
"the :ref:`I Have a Question <i-have-a-question>` section."
#: ../../root/contributing.rst:85
msgid ""
@@ -220,8 +223,8 @@ msgid ""
"Также поищите в интернете (включая `Stack Overflow`), чтобы узнать, "
"обсуждалась ли проблема за пределами `GitHub`."
msgstr ""
"Also search the internet (including `Stack Overflow`) to see if the issue has "
"been discussed outside of `GitHub`."
"Also search the internet (including `Stack Overflow`) to see if the issue"
" has been discussed outside of `GitHub`."
#: ../../root/contributing.rst:87
msgid "Соберите информацию об ошибке:"
@@ -240,7 +243,8 @@ msgid ""
"Версия интерпретатора, компилятора, SDK, среды выполнения, менеджера "
"пакетов и т.д."
msgstr ""
"Version of interpreter, compiler, SDK, runtime environment, package manager, etc."
"Version of interpreter, compiler, SDK, runtime environment, package "
"manager, etc."
#: ../../root/contributing.rst:91
msgid "Входные данные и полученный результат."
@@ -250,8 +254,7 @@ msgstr "Input data and output received."
msgid ""
"Можете ли вы надёжно воспроизвести проблему? Воспроизводится ли она на "
"старых версиях?"
msgstr ""
"Can you reliably reproduce the issue? Does it reproduce on older versions?"
msgstr "Can you reliably reproduce the issue? Does it reproduce on older versions?"
#: ../../root/contributing.rst:95
msgid "Как мне отправить хороший отчет об ошибке?"
@@ -263,15 +266,14 @@ msgid ""
"конфиденциальной информацией в публичном трекере. Для этого используйте "
"электронную почту."
msgstr ""
"Never report security issues, vulnerabilities, or bugs with sensitive information "
"in the public tracker. Use email for this purpose."
"Never report security issues, vulnerabilities, or bugs with sensitive "
"information in the public tracker. Use email for this purpose."
#: ../../root/contributing.rst:100
msgid ""
"Мы используем `GitHub Issues` для отслеживания ошибок. Если вы "
"столкнулись с проблемой:"
msgstr ""
"We use `GitHub Issues` to track bugs. If you encounter a problem:"
msgstr "We use `GitHub Issues` to track bugs. If you encounter a problem:"
#: ../../root/contributing.rst:102
msgid ""
@@ -279,8 +281,8 @@ msgid ""
"<https://github.com/koloideal/Argenta/issues/new>`_. На этом этапе не "
"нужно присваивать ему метки."
msgstr ""
"Open a new `Issue <https://github.com/koloideal/Argenta/issues/new>`_. At this "
"stage, you don't need to assign labels to it."
"Open a new `Issue <https://github.com/koloideal/Argenta/issues/new>`_. At"
" this stage, you don't need to assign labels to it."
#: ../../root/contributing.rst:103
msgid "Объясните ожидаемое и фактическое поведение."
@@ -292,8 +294,9 @@ msgid ""
"воспроизведения**, чтобы проблему можно было воссоздать. Лучше всего "
"изолировать её и создать минимальный тестовый пример."
msgstr ""
"Provide as much context as possible and describe **reproduction steps** so the "
"issue can be recreated. It's best to isolate it and create a minimal test case."
"Provide as much context as possible and describe **reproduction steps** "
"so the issue can be recreated. It's best to isolate it and create a "
"minimal test case."
#: ../../root/contributing.rst:105
msgid "Предоставьте информацию, которую вы собрали в предыдущем разделе."
@@ -314,19 +317,20 @@ msgid ""
"задачу как `needs-repro`. Такие задачи не будут рассматриваться до тех "
"пор, пока проблема не будет воспроизведена."
msgstr ""
"A team member will try to reproduce the issue. If there are no steps or they don't "
"lead to the result, the team will ask you to provide them and mark the issue as "
"`needs-repro`. Such issues will not be addressed until the problem is reproduced."
"A team member will try to reproduce the issue. If there are no steps or "
"they don't lead to the result, the team will ask you to provide them and "
"mark the issue as `needs-repro`. Such issues will not be addressed until "
"the problem is reproduced."
#: ../../root/contributing.rst:111
msgid ""
"Если проблема будет воспроизведена, она будет помечена как `needs-fix` "
"(и, возможно, другими метками, например `critical`), после чего её сможет"
" взять в работу :ref:`любой желающий <Ваш первый вклад в код>`."
" взять в работу :ref:`любой желающий <your-first-code-contribution>`."
msgstr ""
"If the issue is reproduced, it will be marked as `needs-fix` (and possibly with "
"other labels, such as `critical`), after which :ref:`anyone willing <Your First "
"Code Contribution>` can take it on."
"If the issue is reproduced, it will be marked as `needs-fix` (and "
"possibly with other labels, such as `critical`), after which :ref:`anyone"
" willing <your-first-code-contribution>` can take it on."
#: ../../root/contributing.rst:118
msgid "Предложение улучшений"
@@ -339,9 +343,10 @@ msgid ""
" этим рекомендациям поможет мейнтейнерам и сообществу лучше понять вашу "
"идею."
msgstr ""
"This section will help you submit an enhancement suggestion for `Argenta`, "
"**including both new features and minor improvements**. Following these guidelines "
"will help maintainers and the community better understand your idea."
"This section will help you submit an enhancement suggestion for "
"`Argenta`, **including both new features and minor improvements**. "
"Following these guidelines will help maintainers and the community better"
" understand your idea."
#: ../../root/contributing.rst:123
msgid "Перед отправкой предложения по улучшению"
@@ -353,8 +358,9 @@ msgid ""
"убедитесь, что предлагаемая функциональность ещё не реализована "
"(возможно, через конфигурацию)."
msgstr ""
"Carefully read the `documentation <https://argenta.readthedocs.io>`_ and make sure "
"the proposed functionality is not already implemented (perhaps through configuration)."
"Carefully read the `documentation <https://argenta.readthedocs.io>`_ and "
"make sure the proposed functionality is not already implemented (perhaps "
"through configuration)."
#: ../../root/contributing.rst:126
msgid ""
@@ -362,8 +368,9 @@ msgid ""
"проверить, не предлагалось ли это улучшение ранее. Если да, добавьте "
"комментарий к существующей задаче."
msgstr ""
"Perform a `search <https://github.com/koloideal/Argenta/issues>`_ to check if this "
"enhancement has been suggested before. If so, add a comment to the existing issue."
"Perform a `search <https://github.com/koloideal/Argenta/issues>`_ to "
"check if this enhancement has been suggested before. If so, add a comment"
" to the existing issue."
#: ../../root/contributing.rst:127
msgid ""
@@ -372,9 +379,10 @@ msgid ""
"которые будут полезны большинству пользователей. Если ваша идея "
"ориентирована на узкий круг, рассмотрите возможность создания плагина."
msgstr ""
"Determine if your idea fits the scope and goals of the project. You will need to "
"convincingly demonstrate its value. We want to see features that will be useful to "
"most users. If your idea targets a narrow audience, consider creating a plugin."
"Determine if your idea fits the scope and goals of the project. You will "
"need to convincingly demonstrate its value. We want to see features that "
"will be useful to most users. If your idea targets a narrow audience, "
"consider creating a plugin."
#: ../../root/contributing.rst:130
msgid "Как мне отправить хорошее предложение по улучшению?"
@@ -396,7 +404,9 @@ msgstr "Use a **clear and descriptive title** to identify the suggestion."
#: ../../root/contributing.rst:134
msgid "Предоставьте **пошаговое и подробное описание** предлагаемого улучшения."
msgstr "Provide a **step-by-step and detailed description** of the proposed enhancement."
msgstr ""
"Provide a **step-by-step and detailed description** of the proposed "
"enhancement."
#: ../../root/contributing.rst:135
msgid ""
@@ -404,16 +414,17 @@ msgid ""
"вместо этого** и почему. Здесь же можно указать, какие альтернативы вам "
"не подходят."
msgstr ""
"**Describe the current behavior** and **explain what you expected to see instead** "
"and why. You can also mention which alternatives don't work for you."
"**Describe the current behavior** and **explain what you expected to see "
"instead** and why. You can also mention which alternatives don't work for"
" you."
#: ../../root/contributing.rst:136
msgid ""
"**Приложите скриншоты или видео**, которые помогут продемонстрировать "
"шаги или указать на часть, к которой относится предложение."
msgstr ""
"**Attach screenshots or videos** that help demonstrate the steps or point to the "
"part the suggestion relates to."
"**Attach screenshots or videos** that help demonstrate the steps or point"
" to the part the suggestion relates to."
#: ../../root/contributing.rst:137
msgid ""
@@ -421,9 +432,9 @@ msgid ""
"пользователей `Argenta`. Вы также можете указать на другие проекты, "
"которые решили эту проблему и могут послужить источником вдохновения."
msgstr ""
"**Explain why this enhancement would be useful** to most `Argenta` users. You can "
"also point to other projects that have solved this problem and could serve as "
"inspiration."
"**Explain why this enhancement would be useful** to most `Argenta` users."
" You can also point to other projects that have solved this problem and "
"could serve as inspiration."
#: ../../root/contributing.rst:144
msgid "Ваш первый вклад в код"
@@ -435,14 +446,17 @@ msgid ""
"issue` и `help wanted` в нашем репозитории на `GitHub`. Они хорошо "
"подходят для новичков."
msgstr ""
"Don't know where to start? Look at issues labeled `good first issue` and `help "
"wanted` in our `GitHub` repository. They are well-suited for beginners."
"Don't know where to start? Look at issues labeled `good first issue` and "
"`help wanted` in our `GitHub` repository. They are well-suited for "
"beginners."
#: ../../root/contributing.rst:148
msgid ""
"Чтобы начать, настройте локальное окружение для разработки, следуя этим "
"шагам."
msgstr "To get started, set up a local development environment by following these steps."
msgstr ""
"To get started, set up a local development environment by following these"
" steps."
#: ../../root/contributing.rst:150
msgid "Сделайте форк репозитория ``Argenta`` на ``GitHub``."
@@ -465,8 +479,8 @@ msgid ""
"Создайте новую ветку для вашей функции или исправления. Используйте "
"описательное имя, например `fix/login-bug` или `feat/new-widget`."
msgstr ""
"Create a new branch for your feature or fix. Use a descriptive name, such as "
"`fix/login-bug` or `feat/new-widget`."
"Create a new branch for your feature or fix. Use a descriptive name, such"
" as `fix/login-bug` or `feat/new-widget`."
#: ../../root/contributing.rst:182
msgid ""
@@ -491,9 +505,9 @@ msgid ""
"репозитория. Предоставьте чёткое описание проблемы и вашего решения. "
"Укажите номер связанной задачи, если она есть."
msgstr ""
"Open a `Pull Request` from your branch to the `main` branch of the official "
"repository. Provide a clear description of the problem and your solution. Include "
"the related issue number if there is one."
"Open a `Pull Request` from your branch to the `main` branch of the "
"official repository. Provide a clear description of the problem and your "
"solution. Include the related issue number if there is one."
#: ../../root/contributing.rst:204
msgid "Улучшение документации"
@@ -505,9 +519,9 @@ msgid ""
"генерации из исходных файлов в директории `docs/`. Мы приветствуем любые "
"улучшения: от исправления опечатки до написания нового раздела."
msgstr ""
"Good documentation is crucial. We use `Sphinx` to generate it from source files in "
"the `docs/` directory. We welcome any improvements: from fixing a typo to writing "
"a new section."
"Good documentation is crucial. We use `Sphinx` to generate it from source"
" files in the `docs/` directory. We welcome any improvements: from fixing"
" a typo to writing a new section."
#: ../../root/contributing.rst:210
msgid "Мы поддерживаем документацию на двух языках: русском и английском."
@@ -520,24 +534,26 @@ msgid ""
"документации, поэтому рекомендуем вам `установить его "
"<https://github.com/casey/just#installation>`_"
msgstr ""
"To encapsulate various commands needed for setting up and running the project, we "
"use ``just``, which also appears in various examples in the documentation, so we "
"recommend you `install it <https://github.com/casey/just#installation>`_"
"To encapsulate various commands needed for setting up and running the "
"project, we use ``just``, which also appears in various examples in the "
"documentation, so we recommend you `install it "
"<https://github.com/casey/just#installation>`_"
#: ../../root/contributing.rst:216
msgid ""
"Для улучшения документации вы можете следовать процессу, похожему на "
"внесение вклада в код:"
msgstr ""
"To improve documentation, you can follow a process similar to contributing code:"
"To improve documentation, you can follow a process similar to "
"contributing code:"
#: ../../root/contributing.rst:218
msgid ""
"Убедитесь, что ваше окружение для разработки настроено, как описано в "
"разделе `Ваш первый вклад в код`_."
"разделе :ref:`Ваш первый вклад в код <your-first-code-contribution>`."
msgstr ""
"Make sure your development environment is set up as described in the `Your First "
"Code Contribution`_ section."
"Make sure your development environment is set up as described in the "
":ref:`Your First Code Contribution <your-first-code-contribution>` section."
#: ../../root/contributing.rst:219
msgid "Перейдите в директорию с документацией."
@@ -548,15 +564,16 @@ msgid ""
"Внесите изменения в **русскую** версию документации (`docs/index.rst` "
"и/или `docs/root/*`)."
msgstr ""
"Make changes to the **Russian** version of the documentation (`docs/index.rst` "
"and/or `docs/root/*`)."
"Make changes to the **Russian** version of the documentation "
"(`docs/index.rst` and/or `docs/root/*`)."
#: ../../root/contributing.rst:226
msgid ""
"Чтобы собрать документацию локально в режиме автоматического ребилда и "
"увидеть изменения, выполните:"
msgstr ""
"To build the documentation locally in auto-rebuild mode and see the changes, run:"
"To build the documentation locally in auto-rebuild mode and see the "
"changes, run:"
#: ../../root/contributing.rst:232
msgid ""
@@ -568,7 +585,9 @@ msgstr "Open `127.0.0.1:8000` in your browser to view the generated documentatio
msgid ""
"После завершения работы над русской версией необходимо создать английский"
" перевод:"
msgstr "After completing work on the Russian version, you need to create an English translation:"
msgstr ""
"After completing work on the Russian version, you need to create an "
"English translation:"
#: ../../root/contributing.rst:239
msgid ""
@@ -583,8 +602,8 @@ msgid ""
"Когда изменения будут готовы, сделайте коммит и откройте `Pull Request`. "
"Используйте префикс `docs:` в сообщении коммита."
msgstr ""
"When the changes are ready, commit and open a `Pull Request`. Use the `docs:` "
"prefix in the commit message."
"When the changes are ready, commit and open a `Pull Request`. Use the "
"`docs:` prefix in the commit message."
#: ../../root/contributing.rst:247
msgid "Руководства по стилю"
@@ -601,9 +620,10 @@ msgid ""
"проекта более читаемой и позволяет автоматически генерировать журнал "
"изменений."
msgstr ""
"We follow the `Conventional Commits <https://www.conventionalcommits.org/en/v1.0.0/>`_ "
"specification. This makes the project history more readable and allows automatic "
"changelog generation."
"We follow the `Conventional Commits "
"<https://www.conventionalcommits.org/en/v1.0.0/>`_ specification. This "
"makes the project history more readable and allows automatic changelog "
"generation."
#: ../../root/contributing.rst:255
msgid ""
@@ -639,8 +659,7 @@ msgstr ""
msgid ""
"**refactor**: Изменение кода, которое не исправляет ошибку и не добавляет"
" новую функцию."
msgstr ""
"**refactor**: A code change that neither fixes a bug nor adds a feature."
msgstr "**refactor**: A code change that neither fixes a bug nor adds a feature."
#: ../../root/contributing.rst:272
msgid "**perf**: Изменение кода, улучшающее производительность."
@@ -654,8 +673,7 @@ msgstr "**test**: Adding missing tests or correcting existing tests."
msgid ""
"**chore**: Изменения в процессе сборки или вспомогательных инструментах и"
" библиотеках."
msgstr ""
"**chore**: Changes to the build process or auxiliary tools and libraries."
msgstr "**chore**: Changes to the build process or auxiliary tools and libraries."
#: ../../root/contributing.rst:277
msgid "Примеры"
@@ -682,9 +700,10 @@ msgid ""
"архитектуры проекта, вы можете стать хорошим кандидатом на роль "
"мейнтейнера."
msgstr ""
"We are always looking for enthusiasts to join the team. If you are a regular "
"contributor and have demonstrated a deep understanding of the project's goals and "
"architecture, you may be a good candidate for a maintainer role."
"We are always looking for enthusiasts to join the team. If you are a "
"regular contributor and have demonstrated a deep understanding of the "
"project's goals and architecture, you may be a good candidate for a "
"maintainer role."
#: ../../root/contributing.rst:293
msgid ""
@@ -704,7 +723,9 @@ msgstr "Helping other users with their questions and issues."
msgid ""
"Проверку `Pull Request`'ов от других участников с конструктивной обратной"
" связью."
msgstr "Reviewing `Pull Requests` from other contributors with constructive feedback."
msgstr ""
"Reviewing `Pull Requests` from other contributors with constructive "
"feedback."
#: ../../root/contributing.rst:299
msgid ""
@@ -712,7 +733,7 @@ msgid ""
"лучший способ — быть активным и полезным участником сообщества. "
"Существующие мейнтейнеры заметят ваши усилия и могут связаться с вами."
msgstr ""
"If you are interested in becoming a permanent team member, the best way is to be "
"an active and helpful community contributor. Existing maintainers will notice your "
"efforts and may reach out to you."
"If you are interested in becoming a permanent team member, the best way "
"is to be an active and helpful community contributor. Existing "
"maintainers will notice your efforts and may reach out to you."
@@ -21,7 +21,7 @@ msgstr ""
#: ../../root/dependency_injection.rst:4
msgid "Внедрение зависимостей"
msgstr ""
msgstr "Dependency Injection"
#: ../../root/dependency_injection.rst:6
msgid ""
@@ -30,6 +30,9 @@ msgid ""
" и расширяемый код. Вместо того чтобы обработчики сами создавали нужные "
"им объекты (зависимости), они получают их извне."
msgstr ""
"Dependency Injection (DI) is a design pattern that helps write loosely coupled, "
"easily testable, and extensible code. Instead of handlers creating the objects "
"(dependencies) they need themselves, they receive them from outside."
#: ../../root/dependency_injection.rst:8
msgid ""
@@ -39,10 +42,14 @@ msgid ""
"можно прочитать в `официальной документации dishka "
"<https://dishka.readthedocs.io/en/stable/di_intro.html>`_."
msgstr ""
"``Argenta`` uses the ``dishka`` library to implement DI, which allows you to "
"declaratively declare dependencies directly in your handler signatures. You can "
"read more about **DI**, **IoC**, and the API for creating providers in the "
"`official dishka documentation <https://dishka.readthedocs.io/en/stable/di_intro.html>`_."
#: ../../root/dependency_injection.rst:14
msgid "Основная идея"
msgstr ""
msgstr "Main Idea"
#: ../../root/dependency_injection.rst:16
msgid ""
@@ -50,19 +57,24 @@ msgid ""
"данных. Вместо импорта и инициализации соединения внутри функции, вы "
"просто объявляете его как аргумент с аннотацией типа:"
msgstr ""
"Imagine your handler needs access to a database to work. Instead of importing and "
"initializing the connection inside the function, you simply declare it as an "
"argument with a type annotation:"
#: ../../root/dependency_injection.rst:19
msgid ""
"``argenta.di.FromDishka`` является алиасом для ``dishka.FromDishka``, и "
"они полностью взаимозаменяемы."
msgstr ""
"``argenta.di.FromDishka`` is an alias for ``dishka.FromDishka``, and they are "
"fully interchangeable."
#: ../../root/dependency_injection.rst:21
#: ../../root/dependency_injection.rst:29
#: ../../root/dependency_injection.rst:37
#: ../../root/dependency_injection.rst:60
msgid "**Пример использования:**"
msgstr ""
msgstr "**Usage example:**"
#: ../../root/dependency_injection.rst:27
msgid ""
@@ -70,18 +82,20 @@ msgid ""
"``Connection`` и внедрит её. Но прежде чем использовать зависимость, её "
"необходимо объявить в провайдере:"
msgstr ""
"``Argenta`` with ``dishka`` will resolve the dependency by type ``Connection`` and "
"inject it. But before using the dependency, it must be declared in a provider:"
#: ../../root/dependency_injection.rst:35
msgid "После создания провайдера его необходимо зарегистрировать в оркестраторе:"
msgstr ""
msgstr "After creating the provider, it must be registered in the orchestrator:"
#: ../../root/dependency_injection.rst:46
msgid "Как это работает?"
msgstr ""
msgstr "How Does It Work?"
#: ../../root/dependency_injection.rst:48
msgid "В основе DI в Argenta лежат **провайдеры** и **контейнер**."
msgstr ""
msgstr "DI in Argenta is based on **providers** and a **container**."
#: ../../root/dependency_injection.rst:50
msgid ""
@@ -89,16 +103,21 @@ msgid ""
"создавать и настраивать ту или иную зависимость (например, подключение к "
"БД, API-клиент или любой другой сервис)."
msgstr ""
"**Provider (``Provider``)** is a \"recipe\" that explains how to create and "
"configure a particular dependency (for example, a database connection, API client, "
"or any other service)."
#: ../../root/dependency_injection.rst:51
msgid ""
"**Контейнер (IoC Container)** — это \"фабрика\", которая хранит все "
"рецепты (провайдеры) и по запросу создаёт и выдаёт готовые зависимости."
msgstr ""
"**Container (IoC Container)** is a \"factory\" that stores all recipes (providers) "
"and creates and provides ready dependencies on request."
#: ../../root/dependency_injection.rst:56
msgid "Встроенные провайдеры"
msgstr ""
msgstr "Built-in Providers"
#: ../../root/dependency_injection.rst:58
msgid ""
@@ -107,10 +126,14 @@ msgid ""
" можете получить объект ``ArgSpace``, который содержит аргументы "
"командной строки, переданные при запуске приложения."
msgstr ""
"``Argenta`` comes with a built-in provider that gives access to important system "
"dependencies without additional configuration. For example, you can get the "
"``ArgSpace`` object, which contains the command-line arguments passed when the "
"application was launched."
#: ../../root/dependency_injection.rst:69
msgid "Обмен данными между обработчиками"
msgstr ""
msgstr "Data Exchange Between Handlers"
#: ../../root/dependency_injection.rst:71
msgid ""
@@ -118,14 +141,17 @@ msgid ""
"**объект контекста**. В ``Argenta`` эту роль выполняет объект "
"``DataBridge``."
msgstr ""
"In addition to DI, handlers can exchange data within a session through a **context "
"object**. In ``Argenta``, this role is performed by the ``DataBridge`` object."
#: ../../root/dependency_injection.rst:73
msgid ""
"Каждый обработчик может записывать в него данные, а также читать, "
"обновлять и удалять их."
msgstr ""
"Each handler can write data to it, as well as read, update, and delete data."
#: ../../root/dependency_injection.rst:76
msgid "Подробнее об этом можно прочитать в разделе :ref:`root_api_bridge`."
msgstr ""
msgstr "You can read more about this in the :ref:`root_api_bridge` section."
@@ -21,7 +21,7 @@ msgstr ""
#: ../../root/error_handling.rst:4
msgid "Обработка ошибок"
msgstr ""
msgstr "Error Handling"
#: ../../root/error_handling.rst:6
msgid ""
@@ -31,6 +31,10 @@ msgid ""
"сеттеров экземпляра ``App`` вида ``.set_*_handler()``. Подробнее о каждом"
" из них рассказано :ref:`ниже <possible_errors>`."
msgstr ""
"``Argenta`` throws exceptions in edge cases related to user input. By default, "
"they are handled by system handlers, but you can override them. This is done using "
"``App`` instance setters of the form ``.set_*_handler()``. More details about each "
"of them are described :ref:`below <possible_errors>`."
#: ../../root/error_handling.rst:10
msgid ""
@@ -38,20 +42,22 @@ msgid ""
" предусмотрен стандартный обработчик. Поэтому переопределение является "
"опциональным."
msgstr ""
"No exception goes unhandled, as a default handler is provided for each case. "
"Therefore, overriding is optional."
#: ../../root/error_handling.rst:12 ../../root/error_handling.rst:37
#: ../../root/error_handling.rst:61 ../../root/error_handling.rst:82
#: ../../root/error_handling.rst:105 ../../root/error_handling.rst:126
msgid "**Пример использования:**"
msgstr ""
msgstr "**Usage example:**"
#: ../../root/error_handling.rst:22
msgid "Возможные исключения и нестандартное поведение"
msgstr ""
msgstr "Possible Exceptions and Non-Standard Behavior"
#: ../../root/error_handling.rst:25
msgid "``UnprocessedInputFlagException``: Некорректный синтаксис флагов"
msgstr ""
msgstr "``UnprocessedInputFlagException``: Incorrect Flag Syntax"
#: ../../root/error_handling.rst:27
msgid ""
@@ -60,11 +66,14 @@ msgid ""
"синтаксисе флагов. Подробнее о них можно прочитать в разделе :ref:`Flags "
"<root_flags>`."
msgstr ""
"This exception is thrown when the parser cannot process a command due to incorrect "
"syntax. Most often this is related to an error in flag syntax. You can read more "
"about them in the :ref:`Flags <root_flags>` section."
#: ../../root/error_handling.rst:29 ../../root/error_handling.rst:53
#: ../../root/error_handling.rst:74 ../../root/error_handling.rst:97
msgid "Стандартный обработчик выводит в консоль:"
msgstr ""
msgstr "The default handler outputs to the console:"
#: ../../root/error_handling.rst:35
msgid ""
@@ -73,10 +82,13 @@ msgid ""
"обработчик с сигнатурой ``Callable[[str], None]``, где единственный "
"аргумент — это строка с необработанной командой."
msgstr ""
"To override, use the ``.set_incorrect_input_syntax_handler()`` setter. It accepts "
"a handler with the signature ``Callable[[str], None]``, where the only argument is "
"a string with the unprocessed command."
#: ../../root/error_handling.rst:46
msgid "``RepeatedInputFlagsException``: Повторяющиеся флаги в команде"
msgstr ""
msgstr "``RepeatedInputFlagsException``: Repeated Flags in Command"
#: ../../root/error_handling.rst:48
msgid ""
@@ -85,12 +97,18 @@ msgid ""
"считаются одинаковыми, если у них совпадают имена. Подробнее о флагах и "
"их синтаксисе — в разделе :ref:`Flags <root_flags>`."
msgstr ""
"The exception is thrown if the user entered a command with repeated flags. Two "
"flags (:ref:`InputFlag <root_api_command_input_flag>`) are considered the same if "
"their names match. More about flags and their syntax in the :ref:`Flags "
"<root_flags>` section."
#: ../../root/error_handling.rst:51
msgid ""
"Сравнение на равенство у регистрируемых флагов (``Flag``) происходит "
"иначе, подробнее в :ref:`Flag <root_flags>`."
msgstr ""
"Equality comparison for registered flags (``Flag``) works differently, see "
":ref:`Flag <root_flags>` for details."
#: ../../root/error_handling.rst:59
msgid ""
@@ -99,10 +117,13 @@ msgid ""
"с сигнатурой ``Callable[[str], None]``, где единственный аргумент — это "
"строка с необработанной командой."
msgstr ""
"To override, use the ``.set_repeated_input_flags_handler()`` setter. It accepts a "
"handler with the signature ``Callable[[str], None]``, where the only argument is a "
"string with the unprocessed command."
#: ../../root/error_handling.rst:70
msgid "``EmptyInputCommandException``: Введена пустая команда"
msgstr ""
msgstr "``EmptyInputCommandException``: Empty Command Entered"
#: ../../root/error_handling.rst:72
msgid ""
@@ -110,6 +131,8 @@ msgid ""
"строку, состоящую только из пробельных символов (``\\n``, ``\\t``, пробел"
" и т.д.)."
msgstr ""
"The exception is thrown if the user entered an empty string or a string consisting "
"only of whitespace characters (``\\n``, ``\\t``, space, etc.)."
#: ../../root/error_handling.rst:80
msgid ""
@@ -117,10 +140,12 @@ msgid ""
" Он принимает на вход обработчик с сигнатурой ``Callable[[], None]`` (без"
" аргументов)."
msgstr ""
"To override, use the ``.set_empty_command_handler()`` setter. It accepts a handler "
"with the signature ``Callable[[], None]`` (no arguments)."
#: ../../root/error_handling.rst:93
msgid "Обработка неизвестной команды"
msgstr ""
msgstr "Handling Unknown Commands"
#: ../../root/error_handling.rst:95
msgid ""
@@ -128,6 +153,8 @@ msgid ""
" зарегистрирована ни в одном из роутеров и не является псевдонимом "
"(alias) для существующей команды."
msgstr ""
"This behavior is triggered when the user enters a command that is not registered "
"in any of the routers and is not an alias for an existing command."
#: ../../root/error_handling.rst:103
msgid ""
@@ -136,22 +163,26 @@ msgid ""
"сигнатурой ``Callable[[InputCommand], None]``, где аргумент — объект "
":ref:`InputCommand <root_api_command_input_command>`."
msgstr ""
"To override, use the ``.set_unknown_command_handler()`` setter. It accepts a "
"handler with the signature ``Callable[[InputCommand], None]``, where the argument "
"is an :ref:`InputCommand <root_api_command_input_command>` object."
#: ../../root/error_handling.rst:114
msgid "Выход из приложения"
msgstr ""
msgstr "Exiting the Application"
#: ../../root/error_handling.rst:116
msgid ""
"Это поведение активируется, когда пользователь вводит команду, помеченную"
" как команда выхода."
msgstr ""
"This behavior is triggered when the user enters a command marked as an exit command."
#: ../../root/error_handling.rst:118
msgid ""
"Стандартный обработчик выводит в консоль текст и завершает работу "
"приложения:"
msgstr ""
msgstr "The default handler outputs text to the console and terminates the application:"
#: ../../root/error_handling.rst:124
msgid ""
@@ -159,4 +190,7 @@ msgid ""
"Он принимает на вход обработчик с сигнатурой ``Callable[[Response], "
"None]``, где аргумент — объект :ref:`Response <root_api_response>`."
msgstr ""
"To override, use the ``.set_exit_command_handler()`` setter. It accepts a handler "
"with the signature ``Callable[[Response], None]``, where the argument is a "
":ref:`Response <root_api_response>` object."
+21 -21
View File
@@ -18,22 +18,22 @@
* Сослаться на проект в `README` вашего репозитория.
* Упомянуть проект на митапах и рассказать о нём друзьям и коллегам.
.. _Содержание:
.. _contents:
Содержание
----------
* `Кодекс поведения`_
* `У меня есть вопрос`_
* `Я хочу внести вклад`_
* `Сообщение об ошибках`_
* `Предложение улучшений`_
* `Ваш первый вклад в код`_
* `Улучшение документации`_
* `Руководства по стилю`_
* `Присоединяйтесь к команде проекта`_
* :ref:`Кодекс поведения <code-of-conduct>`
* :ref:`У меня есть вопрос <i-have-a-question>`
* :ref:`Я хочу внести вклад <i-want-to-contribute>`
* :ref:`Сообщение об ошибках <reporting-bugs>`
* :ref:`Предложение улучшений <suggesting-enhancements>`
* :ref:`Ваш первый вклад в код <your-first-code-contribution>`
* :ref:`Улучшение документации <improving-documentation>`
* :ref:`Руководства по стилю <styleguide>`
* :ref:`Присоединяйтесь к команде проекта <join-the-project-team>`
.. _Кодекс поведения:
.. _code-of-conduct:
Кодекс поведения
----------------
@@ -43,7 +43,7 @@
-----
.. _У меня есть вопрос:
.. _i-have-a-question:
У меня есть вопрос
------------------
@@ -60,7 +60,7 @@
-----
.. _Я хочу внести вклад:
.. _i-want-to-contribute:
Я хочу внести вклад
-------------------
@@ -71,7 +71,7 @@
Внося вклад в этот проект, вы подтверждаете, что являетесь автором 100% контента, обладаете необходимыми правами на него и соглашаетесь, что он может распространяться под лицензией проекта.
.. _Сообщение об ошибках:
.. _reporting-bugs:
Сообщение об ошибках
--------------------
@@ -81,7 +81,7 @@
Хороший отчёт об ошибке не должен заставлять других вытягивать из вас дополнительную информацию. Пожалуйста, тщательно всё изучите, соберите информацию и подробно опишите проблему. Это поможет нам исправить её как можно быстрее.
* Убедитесь, что вы используете последнюю версию.
* Убедитесь, что проблема действительно является ошибкой, а не вызвана, например, использованием несовместимых версий окружения. Прочтите `документацию <https://argenta.readthedocs.io>`_ и, если нужна поддержка, загляните в раздел `У меня есть вопрос`_.
* Убедитесь, что проблема действительно является ошибкой, а не вызвана, например, использованием несовместимых версий окружения. Прочтите `документацию <https://argenta.readthedocs.io>`_ и, если нужна поддержка, загляните в раздел :ref:`У меня есть вопрос <i-have-a-question>`.
* Проверьте, нет ли уже отчёта о вашей ошибке в `трекере <https://github.com/koloideal/Argenta/issues?q=label%3Abug>`_.
* Также поищите в интернете (включая `Stack Overflow`), чтобы узнать, обсуждалась ли проблема за пределами `GitHub`.
* Соберите информацию об ошибке:
@@ -108,11 +108,11 @@
* Команда проекта присвоит задаче соответствующую метку.
* Член команды попытается воспроизвести проблему. Если шагов нет или они не приводят к результату, команда попросит вас предоставить их и пометит задачу как `needs-repro`. Такие задачи не будут рассматриваться до тех пор, пока проблема не будет воспроизведена.
* Если проблема будет воспроизведена, она будет помечена как `needs-fix` (и, возможно, другими метками, например `critical`), после чего её сможет взять в работу :ref:`любой желающий <Ваш первый вклад в код>`.
* Если проблема будет воспроизведена, она будет помечена как `needs-fix` (и, возможно, другими метками, например `critical`), после чего её сможет взять в работу :ref:`любой желающий <your-first-code-contribution>`.
-----
.. _Предложение улучшений:
.. _suggesting-enhancements:
Предложение улучшений
---------------------
@@ -138,7 +138,7 @@
-----
.. _Ваш первый вклад в код:
.. _your-first-code-contribution:
Ваш первый вклад в код
-----------------------
@@ -198,7 +198,7 @@
-----
.. _Улучшение документации:
.. _improving-documentation:
Улучшение документации
----------------------
@@ -215,7 +215,7 @@
Для улучшения документации вы можете следовать процессу, похожему на внесение вклада в код:
#. Убедитесь, что ваше окружение для разработки настроено, как описано в разделе `Ваш первый вклад в код`_.
#. Убедитесь, что ваше окружение для разработки настроено, как описано в разделе :ref:`Ваш первый вклад в код <your-first-code-contribution>`.
#. Перейдите в директорию с документацией.
.. code-block:: bash
@@ -283,7 +283,7 @@
-----
.. _Присоединяйтесь к команде проекта:
.. _join-the-project-team:
Присоединяйтесь к команде проекта
---------------------------------