8000 Apply suggestions from code review · fastapi/fastapi@13d2845 · GitHub
[go: up one dir, main page]

Skip to content

Commit 13d2845

Browse files
TabarakoAkulaivan-abcAlexandrhub
authored
Apply suggestions from code review
Co-authored-by: ivan-abc <36765187+ivan-abc@users.noreply.github.com> Co-authored-by: Alexandr <alexandrhub@vk.com>
1 parent 02497fd commit 13d2845

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

docs/ru/docs/tutorial/path-operation-configuration.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,12 @@
3131
{!> ../../../docs_src/path_operation_configuration/tutorial001.py!}
3232
```
3333

34-
Этот код состояния будет использован в ответе, и будет добавлен в схему OpenAPI.
34+
Этот код состояния будет использован в ответе и будет добавлен в схему OpenAPI.
3535

3636
!!! note "Технические детали"
3737
Вы также можете использовать `from starlette import status`.
3838

39-
**FastAPI** предоставляет тот же `starlette.status`, что и `fastapi.status` для удобства разработчкиа. Но идет он непросредственно от Starlette.
39+
**FastAPI** предоставляет тот же `starlette.status` под псевдонимом `fastapi.status` для удобства разработчика. Но его источник - это непосредственно Starlette.
4040

4141
## Теги
4242

@@ -66,19 +66,19 @@
6666

6767
### Теги с перечислениями
6868

69-
Если у вас большое приложение, под конец вы можете набрать **несколько тегов**, и вы можете хотеть убедиться в том, что всегда используете **один и тот же тег** для связанных *операций пути*.
69+
Если у вас большое приложение, вы можете прийти к необходимости добавить **несколько тегов**, и возможно, вы захотите убедиться в том, что всегда используете **один и тот же тег** для связанных *операций пути*.
7070

71-
В этих случаях, имеет смысл хранить теги в `Enum`.
71+
В этих случаях, имеет смысл хранить теги в классе `Enum`.
7272

73-
**FastAPI** поддерживает это также, как и с обычными строками:
73+
**FastAPI** поддерживает это так же, как и в случае с обычными строками:
7474

7575
```Python hl_lines="1 8-10 13 18"
7676
{!../../../docs_src/path_operation_configuration/tutorial002b.py!}
7777
```
7878

7979
## Краткое и развёрнутое содержание
8080

81-
Вы можете добавить `summary` и `description`:
81+
Вы можете добавить параметры `summary` и `description`:
8282

8383
=== "Python 3.10+"
8484

@@ -100,9 +100,9 @@
100100

101101
## Описание из строк документации
102102

103-
Так как описания обычно длинные и содержат много строк, вы можете объявить описание *операции пути* в функции <abbr title="многострочный текст в качестве первого выражения внутри функции (не присвоенная какой-либо переменной), используемый для документации">строки документации</abbr> и **FastAPI** прочитает её отсюда.
103+
Так как описания обычно длинные и содержат много строк, вы можете объявить описание *операции пути* в функции <abbr title="многострочный текст, первое выражение внутри функции (не присвоенный какой-либо переменной), используемый для документации">строки документации</abbr> и **FastAPI** прочитает её отсюда.
104104

105-
Вы можете использовать <a href="https://en.wikipedia.org/wiki/Markdown" class="external-link" target="_blank">Markdown</a> в строке документации, и оно будет интерпретировано и отображено корректно (с учетом отступа в строке документации).
105+
Вы можете использовать <a href="https://en.wikipedia.org/wiki/Markdown" class="external-link" target="_blank">Markdown</a> в строке документации, и он будет интерпретирован и отображён корректно (с учетом отступа в строке документации).
106106

107107
=== "Python 3.10+"
108108

@@ -149,18 +149,18 @@
149149
```
150150

151151
!!! info "Дополнительная информация"
152-
Помните, что `response_description` относится конкретно к ответу, а `description` в основном относится к *операциям пути*.
152+
Помните, что `response_description` относится конкретно к ответу, а `description` относится к *операции пути* в целом.
153153

154154
!!! check "Технические детали"
155155
OpenAPI указывает, что каждой *операции пути* необходимо описание ответа.
156156

157-
Если вдруг вы не укажите одно из них, то **FastAPI** автоматически сгенерирует один из "Удачных ответов".
157+
Если вдруг вы не укажете его, то **FastAPI** автоматически сгенерирует это описание с текстом "Successful response".
158158

159159
<img src="/img/tutorial/path-operation-configuration/image03.png">
160160

161161
## Обозначение *операции пути* как устаревшей
162162

163-
Если вам необходимо пометить *операцию пути* как <abbr title="устаревшее, не рекомендовано к использованию">устаревшую</abbr>, но без её удаления, передайте параметр `deprecated`:
163+
Если вам необходимо пометить *операцию пути* как <abbr title="устаревшее, не рекомендовано к использованию">устаревшую</abbr>, при этом не удаляя её, передайте параметр `deprecated`:
164164

165165
```Python hl_lines="16"
166166
{!../../../docs_src/path_operation_configuration/tutorial006.py!}
@@ -170,7 +170,7 @@
170170

171171
<img src="/img/tutorial/path-operation-configuration/image04.png">
172172

173-
Проверьте, как устаревшие и не-устаревшие *операции пути* будут выглядеть:
173+
Проверьте, как будут выглядеть устаревшие и не устаревшие *операции пути*:
174174

175175
<img src="/img/tutorial/path-operation-configuration/image05.png">
176176

0 commit comments

Comments
 (0)
0