Skip to content

Fix link to object if it is exposed in __all__ #670

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

Merged
merged 13 commits into from
Jul 10, 2024

Conversation

nathanthorpe
Copy link
Contributor

Related issue #669

Search through the possible sources of the module when looking in all_modules.
Also use the path of the matched object.

…h all modules, use module name of the matched item
Copy link
Member

@mhils mhils left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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!

@nathanthorpe
Copy link
Contributor Author

Thanks for looking into it!
Ok I believe I've made the appropriate test case. Also added a changelog entry.

staceybellerose added a commit to staceybellerose/pdoc that referenced this pull request Apr 8, 2024
@liborvaneksw
Copy link

Hi! I'm facing the same issue. Unfortunately, this PR seems a bit stale. Do you plan to continue with this? Do you need a hand?

nathanthorpe and others added 3 commits June 11, 2024 12:39
# Conflicts:
#	test/testdata/demopackage.html
#	test/testdata/demopackage_dir.html
@nathanthorpe
Copy link
Contributor Author

This PR should be ready for merge

@mhils
Copy link
Member

mhils commented Jul 10, 2024

Sorry this took so long! I've finally found some time do do a deep dive here and refactor things a bit. Does this look good to you now?

@nathanthorpe
Copy link
Contributor Author

I just tested it and it looks great, thank you!

@mhils mhils enabled auto-merge (squash) July 10, 2024 18:25
@mhils mhils merged commit 8939754 into mitmproxy:main Jul 10, 2024
12 checks passed
@nathanthorpe nathanthorpe deleted the fix-link-when-exported branch July 10, 2024 20:52
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