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
Remove needless nitpick-expections #16288
base: main
Are you sure you want to change the base?
Conversation
Thank you for your contribution to Astropy! 🌌 This checklist is meant to remind the package maintainers who will review this pull request of some common things to look for.
|
👋 Thank you for your draft pull request! Do you know that you can use |
fa0a9e6
to
b98e433
Compare
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.
Thanks for the clean-up! For some, I have no idea why they didn't work before, for others no idea why they still are necessary, but happy to take the reduction! Approved since the readthedocs build succeeded.
I did not look into that at all. I just deleted everything in the file, built the documentation locally and restored all the exceptions that were still needed. Now that the clutter has been removed it should be simpler to look into why some of these exceptions are still needed. |
b98e433
to
6628b6e
Compare
6628b6e
to
7781cb7
Compare
py:obj n | ||
py:obj ndarray | ||
py:obj args | ||
|
||
# other classes and functions that cannot be linked to | ||
# NUMPY_LT_2_0: numpy 2.0 changed numpy.core to numpy._core |
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.
As for numpy.core
vs numpy._core
here, won't this come back to haunt us when numpy 2.0 is released and RTD picks it up? 🤔
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'd rather not worry about this unless there is proof this is worth worrying about.
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.
We might just end up reverting a few of these lines when numpy 2.0 is released, so what is the point of removing it too soon? Should this PR wait till after numpy 2.0 is released?
py:class None. Update D from dict/iterable E and F. | ||
py:class an object providing a view on D's values | ||
py:class a shallow copy of D | ||
|
||
# This extends the numpydoc list above to fix lincheck warning |
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.
This comment mentions linkcheck, so I want to run linkcheck job but the skipping CI in commit has prevented this.
7781cb7
to
327e7e0
Compare
I'm converting this to a draft in response to #16288 (comment) and we can have another look at this once |
Thank you for your understanding! |
Description
If the documentation build on RTD doesn't raise warnings about reference targets not being found then there is no reason to have exceptions for such warnings.