Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Улучшение документации для v3 #25

Open
wants to merge 60 commits into
base: master
Choose a base branch
from

Conversation

Damego
Copy link
Contributor

@Damego Damego commented Jan 8, 2023

Список изменений:

  1. Добавлены пробелы для переноса строк. Иначе все будет в одну строку
  2. Удалён символ со всех методов, так как он ломает ссылки, и по ним нельзя перейти.
  3. Исправлено некорректное отображение некоторых таблиц.
  4. Перенесён метод /user/favourites после метода /user, а не перед ним. Так выглядит более логичней.
  5. Исправлены некоторые нерабочие ссылки.
  6. Переименован <Major> на Major, и с остальными. GitHub считает их HTML тегами. Пользователь видит просто точки ..
  7. Расширен пункт про пагинацию, добавлена ссылка на объект пагинации для некоторых методов.
  8. Исправлены примеры ответов. (Во многих методах отсутствовали скобки)
  9. Красивое оформление методов в начале. Добавлен символ / и эндпоинты занесены в блок кода

@Damego Damego marked this pull request as draft January 9, 2023 12:23
@Damego Damego marked this pull request as ready for review January 9, 2023 16:27
@T1MOXA
Copy link
Collaborator

T1MOXA commented Apr 27, 2023

Спасибо за правки.
Пересмотрю как будет время.
К сожалению не успел к релизу последней версии.

api_v2.md Outdated Show resolved Hide resolved
api_v2.md Outdated Show resolved Hide resolved
@Damego Damego changed the title Api Docs v3. Реформат файла Улучшение документации для v3 Apr 29, 2023
@Damego
Copy link
Contributor Author

Damego commented Apr 29, 2023

Обновил документацию с последним обновлением.

Так как этот коммит был каким-то образом неправильно закоммичен, то изменения этого пулл реквеста более не показываются.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants