fix: drop CrossrefProcessor that corrupts URL fragments in docstrings#83
Merged
Conversation
Author
|
@barjin see apify/apify-client-python#865 - for the consequences this causes. |
Member
|
released in |
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
3 participants
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.
pydoc-markdown's
CrossrefProcessoris run withresolver=Noneingenerate_ast.py, so it can never resolve a#refinto a real link — it only falls back to wrapping the ref in backticks. Its regex\B#([\w\d._]+)also matches any#wordpreceded by a non-word char, so URL fragments like.../dockerfile_best-practices/#leverage-build-cache(the/#sequence) get corrupted into broken links such as...best-practices/`leverage`-build-cache.The Apify docstrings don't use
#refcross-references, so this dropsCrossrefProcessorfrom the processor list — it brought no benefit (never produced links) and only corrupted fragments. This also matches the griffe-based extractor, which doesn't run it either.Verified by running the patched
generate_ast.pyagainst apify-client-python: the generated AST now contains#leverage-build-cacheintact.