-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
Fix: Don't link to undocumented types in API docs #14878
Fix: Don't link to undocumented types in API docs #14878
Conversation
Co-authored-by: Sijawusz Pur Rahnama <[email protected]>
Maybe it would make more sense to pass |
Why? What would that improve? If they're instance methods on |
To make it clear in the html template from where the types are fetched, but maybe one should understand that from the context. |
I see. Maybe it could make sense to move the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I understand @Sija's feeling: I liked the type.subclasses
notation that was a little more explicit (i.e. I want the subclasses of type
). We can't do that because we need types
from the template, and filtering in the template sounds like the correct place... so what about a filter method, for example with_docs(type.subclasses)
?
Now this is nitpicking and the PR can be merged as-is 👍
I noticed while looking into the latest comment on #12018, that this PR may have changed more than we expected? The I can move this to its own issue if this is indeed a regression. |
Yeah, that doesn't seem to work correctly. I believe |
This reverts commit 78c9282.
I believe the filtering must be done in |
This patch was eventually reverted in #14908 due to #14878 (comment) |
Fixes #9816