Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Remove needless nitpick-expections #16288

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Remove needless nitpick-expections #16288

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
49 changes: 1 addition & 48 deletions docs/nitpick-exceptions
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,14 @@
# astropy.cosmology
py:class astropy.cosmology.Cosmology
py:class astropy.cosmology.core.Cosmology

# astropy.io.votable
py:class astropy.io.votable.tree.Element
py:class astropy.io.votable.tree.SimpleElement
py:class astropy.io.votable.tree.SimpleElementWithContent

# astropy.modeling
py:class astropy.modeling.projections.Zenithal
py:class astropy.modeling.projections.Cylindrical
py:class astropy.modeling.polynomial.PolynomialBase
py:class astropy.modeling.rotations.EulerAngleRotation
py:class astropy.modeling.projections.Projection

# astropy.io.fits
py:class astropy.io.fits.hdu.base.ExtensionHDU
py:class astropy.io.fits.util.NotifierMixin
py:class astropy.io.fits.hdu.compressed._codecs.Codec
py:class numcodecs.abc.Codec

# astropy.io.misc.yaml
py:class yaml.dumper.SafeDumper
Expand All @@ -28,7 +18,6 @@ py:class yaml.scanner.Scanner
py:class yaml.constructor.SafeConstructor
py:class yaml.constructor.BaseConstructor
py:class yaml.parser.Parser
py:class yaml.dumper.SafeDumper
py:class yaml.representer.BaseRepresenter
py:class yaml.reader.Reader
py:class yaml.resolver.BaseResolver
Expand All @@ -38,31 +27,20 @@ py:class yaml.resolver.Resolver
py:class yaml.emitter.Emitter

# astropy.units
# This is required on macOS (#9040 and #10026) and Windows (#16288).
py:obj astropy.units.function.logarithmic.m_bol

pllim marked this conversation as resolved.
Show resolved Hide resolved
# astropy.utils
py:class astropy.extern.six.Iterator
py:class type
py:class json.encoder.JSONEncoder

# astropy.table
py:class astropy.table.column.BaseColumn
py:class astropy.table.groups.BaseGroups
py:class astropy.table.bst.FastBase

# astropy.time
py:class astropy.time.core.TimeUnique

# astropy.visualization
py:class matplotlib.axes._subplots.WCSAxesSubplot
py:obj Bbox
py:obj Transform
py:obj Patch
py:obj Figure
py:obj AbstractPathEffect
py:obj ScaleBase
py:obj matplotlib.axis.Axes.get_window_extent
py:obj matplotlib.spines.get_window_extent
py:obj N

# astropy.wcs
Expand All @@ -72,58 +50,33 @@ py:class astropy.wcs.wcsapi.fitswcs.custom_ctype_to_ucd_mapping
# numpy inherited docstrings
py:obj dtype
py:obj a
py:obj a.size == 1
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
py:class numpy.ma.core.MaskedArray
Copy link
Member

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? 🤔

Copy link
Member Author

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.

Copy link
Member

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 numpy.ma.mvoid
py:class numpy.void
py:class numpy.core.records.recarray
py:class numpy._core.records.recarray
py:class xmlrpclib.Fault
py:class xmlrpclib.Error
py:class xmlrpc.client.Fault
py:class xmlrpc.client.Error
py:obj pkg_resources.parse_version
py:class pandas.DataFrame

# Pending on python docs links issue #11975
py:class list
py:obj list.append
py:obj list.append
py:obj list.count
py:obj list.extend
py:obj list.index
py:obj list.insert
py:meth list.pop
py:obj list.remove
py:class classmethod
py:obj RuntimeError
py:obj NotImplementedError
py:obj AttributeError
py:obj NotImplementedError
py:obj RendererBase
py:obj Artist
py:obj BboxBase
py:obj Text
py:obj text

# This list is from https://github.com/numpy/numpydoc/issues/275
py:class None. Remove all items from D.
py:class a set-like object providing a view on D's items
py:class a set-like object providing a view on D's keys
py:class v, remove specified key and return the corresponding value.
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
py:class reference target not found: (k, v)
Copy link
Member

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.


# Types used in annotations included here because of a Sphinx bug.
# See https://github.com/sphinx-doc/sphinx/issues/9813
# and https://github.com/sphinx-doc/sphinx/issues/11225
Expand Down