Fix link to object if it is exposed in __all__
#670
Conversation
This file contains 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
…h all modules, use module name of the matched item
mhils
reviewed
Feb 23, 2024
There was a problem hiding this comment.
Thank you for the PR! I generally agree that #669 is something we should support. 👍
That being said - we are reaching ugly levels of function complexity here, not sure yet how we can make things simpler. Worst case it just needs more docstrings. I will take a closer look when I have a few cycles. In the meantime, could you please 1) add a snapshot test and 2) a CHANGELOG entry? Thanks!
| if target_exists_and_public: | ||
| assert doc is not None # mypy | ||
| # Check again if the object was re-exposed | ||
| for module, qualname in possible_sources( |
There was a problem hiding this comment.
I think this should use qualname_candidates here.
There was a problem hiding this comment.
qualname is a string in this case, so I don't think it should be candidates
|
Thanks for looking into it! |
staceybellerose
added a commit
to staceybellerose/pdoc
that referenced
this pull request
Apr 8, 2024
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.
Related issue #669
Search through the possible sources of the module when looking in
all_modules.Also use the path of the matched object.