Conversation
…s and fix the issues it reports
|
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.
|
…of the matplotlib docstring and avoid cross-referencing PIL in the imshow docstring
…ely empty docstring is needed to block Sphinx docstring inheritance
| direction : {'in','out'}, optional | ||
| Whether the ticks should point inwards or outwards. | ||
| exclude_overlapping : bool, optional | ||
| Deprecated, use the ``exclude_overlapping`` option of |
There was a problem hiding this comment.
Do we need the .. deprecated directive here with the version in which it was deprecated?
There was a problem hiding this comment.
Oh I didn't know about that, do we use it elsewhere?
There was a problem hiding this comment.
I think the deprecated decorator inserts into docstring automatically during deprecation period. But with manual addition like this, not sure. Is this even rendered? If not, I guess my comment is moot.
There was a problem hiding this comment.
Ok apparently this was deprecated in 3.1 😆
| Parameters | ||
| ---------- | ||
| rule : str | ||
| Deprecated and has no effect. |
There was a problem hiding this comment.
Same question as https://github.com/astropy/astropy/pull/20434/changes#r4048285482
|
|
||
| Parameters | ||
| ---------- | ||
| values : `~astropy.units.Quantity` array, optional |
There was a problem hiding this comment.
Same question as https://github.com/astropy/astropy/pull/20434/changes#r4048320980
| number : int, optional | ||
| Number of ticks. | ||
| The approximate number of ticks. | ||
| spacing : `~astropy.units.Quantity` ['angle'], optional |
There was a problem hiding this comment.
I was wondering how this ['angle'] would render but I cannot seem to find this class listed in https://astropy--20434.org.readthedocs.build/en/20434/visualization/wcsaxes/index.html#reference-api
There was a problem hiding this comment.
Yes that class isn't documented as not really intended to be used publicly
Co-authored-by: P. L. Lim <2090236+pllim@users.noreply.github.com>
…de_overlapping and rule arguments
…ions with a period
|
@pllim - I think I've addressed all your comments, and note that the deprecated directives look like this: 
I've enabled the |
…ain Quantity rather than a Quantity array
|
As to the rendering of [angle], search for 'pressure' here: https://docs.astropy.org/en/latest/api/astropy.coordinates.AltAz.html Note that it looks like the rendering is broken, but it should link to the physical type. Need to investigate what's wrong. |
|
The rendering was fixed in astropy/sphinx-astropy#103 but not yet released - anyway this is tangential to this release but just putting it here for the record. |
… summary lines Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Description
This fixes all the numpydoc issues for the astropy.visualization.wcsaxes module.
AI Disclosure
If AI tools were used to develop this pull request, describe the tools including specific model and version, how they were used, and what content is AI generated. Otherwise enter "N/A".
The bulk of this work was carried out by Claude Fable 5, but I have checked everything manually and very carefully and adjusted things as needed.
Merge method