Skip to content

Commit bda0c5d

Browse files
authored
Merge pull request astropy#3628 from bsipocz/docs_cleanup_regions
DOC: cleanup regions links
2 parents 5f269b4 + 70c49c0 commit bda0c5d

3 files changed

Lines changed: 9 additions & 7 deletions

File tree

astroquery/alma/core.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ def get_enhanced_table(result):
217217
except ImportError:
218218
print(
219219
"Could not import astropy-regions, which is a requirement for get_enhanced_table function in alma."
220-
"Please refer to https://astropy-regions.readthedocs.io/en/latest/installation.html for how to install it.")
220+
"Please refer to the ``regions`` documentation for installation instructions.")
221221
raise
222222

223223
def _parse_stcs_string(input):
@@ -494,7 +494,7 @@ def query_object_async(self, object_name, *, public=True,
494494
calibration, None to return both
495495
enhanced_results : bool
496496
True to return a table with quantities instead of just values. It
497-
also returns the footprint as `regions` objects.
497+
also returns the footprint as ``regions`` objects.
498498
payload : dict
499499
Dictionary of additional keywords. See `help`.
500500
"""
@@ -528,7 +528,7 @@ def query_region_async(self, coordinate, radius, *, public=True,
528528
Dictionary of additional keywords. See `help`.
529529
enhanced_results : bool
530530
True to return a table with quantities instead of just values. It
531-
also returns the footprints as `regions` objects.
531+
also returns the footprints as ``regions`` objects.
532532
"""
533533
rad = radius
534534
if not isinstance(radius, u.Quantity):
@@ -571,7 +571,7 @@ def query_async(self, payload, *, public=True, science=True,
571571
Cap on the amount of records returned. Default is no limit.
572572
enhanced_results : bool
573573
True to return a table with quantities instead of just values. It
574-
also returns the footprints as `regions` objects.
574+
also returns the footprints as ``regions`` objects.
575575
576576
Returns
577577
-------

docs/alma/alma.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -350,7 +350,7 @@ Query Results
350350
Results of queries are returned in tabular format. For convenience,
351351
the `~astroquery.alma.get_enhanced_table` function can be used to have the initial result
352352
in a more useful format, i.e., turn values into quantities, footprint into
353-
shape, etc. (Note: this require the `regions` Python package to be installed.
353+
shape, etc. (Note: this require the `regions`_ Python package to be installed.)
354354
355355
356356
.. doctest-remote-data::
@@ -400,7 +400,7 @@ To further draw the footprint:
400400
401401
The above footprint could be transformed into a pixel region and have the mask
402402
extracted or combined with other regions. Refer to the Astropy affiliated
403-
''regions'' package for more details.
403+
`regions`_ package for more details.
404404
405405
406406
Downloading Data
@@ -521,3 +521,6 @@ Reference/API
521521
522522
.. automodapi:: astroquery.alma.utils
523523
:no-inheritance-diagram:
524+
525+
526+
.. _regions: https://astropy-regions.readthedocs.io

docs/conf.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@
1212
# See astropy.sphinx.conf for which values are set there.
1313

1414
import datetime
15-
import os
1615
import sys
1716
import tomllib
1817
from pathlib import Path

0 commit comments

Comments
 (0)