fix: docs: повторяющиеся якоря исключений в фильтрах mkdocstrings - #195
Open
Pankovea wants to merge 2 commits into
Open
fix: docs: повторяющиеся якоря исключений в фильтрах mkdocstrings#195Pankovea wants to merge 2 commits into
Pankovea wants to merge 2 commits into
Conversation
Фильтры на страницах exceptions/dispatcher и exceptions/max не отсекали «чужие» члены пакета maxapi.exceptions
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Поправлены разметка и пунктуация
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fix: дубликаты якорей исключений ломали
mkdocs build --strictЧто происходило
Проверочная сборка документации в строгом режиме падала с ошибкой:
$ python -m mkdocs build --strict Вывод до исправления — 15 предупреждений и abort:
Разбивка:
MaxApiError×1,DownloadFileError×3,MaxError×11(кратность — число попыток autorefs разрешить ссылки на класс с других страниц).
Причина
Страницы
docs/exceptions/dispatcher.mdиdocs/exceptions/max.mdоберендерят один модуль через
::: maxapi.exceptionsи пытались отбирать«свои» классы фильтрами mkdocstrings. Но семантика фильтров в
mkdocstrings-python (
_keep_object) такова:умолчанию, когда в списке есть хотя бы один exclude-паттерн (
!…).Список
"!^_[^_]", "^HandlerException$", …содержит exclude-паттерн,поэтому все публичные члены без явного include проходили на обеих
страницах. Классы с docstring (
MaxError,MaxApiError,DownloadFileError) рендерились дважды и получали по два primary-якоря;плагин
autorefsфиксировал конфликт на каждую ссылку на них.Исправление
Списки фильтров сделаны эксклюзивными: первым элементом добавлен
catch-all exclude
"!.*"(матчит всё), следом идут include-паттерны.По правилу «последнее совпадение выигрывает» они возвращают нужные
классы, остальные отсекаются:
(аналогично в
max.md).Как теперь
0 warnings, strict проходит. Каждый класс исключений документируется
ровно на одной странице:
HandlerException/MiddlewareException→exceptions/dispatcher, прочие →exceptions/max,DownloadFileError/NotAvailableForDownload→exceptions/download_file.MAX_API_Real_Payloads_2026.mdвне навигации, поэтому перемещён в директорию doc/(каталог девелоперских заметок). Так же в этом файле поправлены разметка и пунктцация