Skip to content

Commit 03238e8

Browse files
committed
Clean bad links from AlmaClass.query_sia docstring
The docstring of `astroquery.alma.AlmaClass.query_sia()` is constructed with the help of `pyvo.dal.sia2.SIA_PARAMETERS_DESC` constant, which however contains links that Sphinx is unable to resolve. These links are removed by this commit so that the documentation build can succeed.
1 parent 0647aa9 commit 03238e8

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

astroquery/alma/core.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -426,6 +426,10 @@ def query_sia(self, pos=None, band=None, time=None, pol=None,
426426
maxrec=maxrec,
427427
**kwargs)
428428

429+
# SIA_PARAMETERS_DESC contains links that Sphinx can't resolve.
430+
for var in ('POLARIZATION_STATES', 'CALIBRATION_LEVELS'):
431+
SIA_PARAMETERS_DESC = SIA_PARAMETERS_DESC.replace(f'`pyvo.dam.obscore.{var}`',
432+
f'pyvo.dam.obscore.{var}')
429433
query_sia.__doc__ = query_sia.__doc__.replace('_SIA2_PARAMETERS', SIA_PARAMETERS_DESC)
430434

431435
def query_tap(self, query, maxrec=None):

0 commit comments

Comments
 (0)