fix cross references in docstrings

Author: zoghbi-a

astroquery/heasarc/core.py

@@ -111,7 +111,7 @@ def get_default_radius(self, catalog_name):
 
         Returns
         -------
-        The radius as ~astropy.units.Quantity
+        The radius as `~astropy.units.Quantity`
 
         """
         meta = self._meta[
@@ -126,12 +126,12 @@ def _set_session(self, session):
 
         Parameters
         ----------
-        session : ~requests.Session
+        session : `~requests.Session`
             The requests.Session to use
 
         """
         if not isinstance(session, requests.Session):
-            raise ValueError('session is not a ~requests.Session instance')
+            raise ValueError('session is not a `~requests.Session` instance')
 
         self._session = session
 
@@ -187,7 +187,7 @@ def query_mission_list(self, *, cache=True, get_query_payload=False):
 
         This method is deprecated, and is included only for limited
         backward compatibility with the old astroquery.Heasarc that uses
-        the Browse interface. Please use ~Heasarc.list_catalogs instead.
+        the Browse interface. Please use `~Heasarc.list_catalogs` instead.
 
         """
         return self.list_catalogs(master=False)
@@ -212,7 +212,7 @@ def list_columns(self, catalog_name, full=False):
         tables = self.tap.tables
         if catalog_name not in tables.keys():
             msg = (f'{catalog_name} is not available as a public catalog. '
-                   'Try passing keywords to ~Heasarc.list_catalogs() to find '
+                   'Try passing keywords to `~Heasarc.list_catalogs` to find '
                    'the catalog name')
             raise ValueError(msg)
 
@@ -238,7 +238,7 @@ def query_mission_cols(self, mission, *, cache=True,
 
         NOTE: This method is deprecated, and is included only for limited
         backward compatibility with the old astroquery.Heasarc that uses
-        the Browse interface. Please use ~Heasarc.list_columns instead.
+        the Browse interface. Please use `~Heasarc.list_columns` instead.
 
         Parameters
         ----------
@@ -324,7 +324,7 @@ def query_region(self, position=None, catalog=None, radius=None, *,
             `astropy.units` may also be used. If None, a default value
             appropriate for the selected catalog is used. To see the default
             radius for the catalog, see
-            ~astroquery.heasarc.Heasarc.get_default_radius.
+            `~astroquery.heasarc.Heasarc.get_default_radius`.
         width : str, `~astropy.units.Quantity` object [Required for
             spatial == ``'box'``.]
             The string must be parsable by `~astropy.coordinates.Angle`. The
@@ -610,7 +610,7 @@ def download_data(self, links, host='heasarc', location='.'):
         if host_column not in links.colnames:
             raise ValueError(
                 f'No {host_column} column found in the table. Call '
-                '~locate_data first'
+                '`~locate_data` first'
             )
 
         if host == 'heasarc':
@@ -632,7 +632,7 @@ def _download_heasarc(self, links, location='.'):
         """Download data from the heasarc main server using xamin's tar servlet
 
         Do not call directly.
-        Users should be using ~self.download_data instead
+        Users should be using `~self.download_data` instead
 
         Parameters
         ----------
@@ -689,7 +689,7 @@ def _copy_sciserver(self, links, location='.'):
         """Copy data from the local archive on sciserver
 
         Do not call directly.
-        Users should be using ~self.download_data instead
+        Users should be using `~self.download_data` instead
 
         """
         if not (os.path.exists('/FTP/') and os.environ['HOME'].split('/')[-1] == 'idies'):
@@ -720,7 +720,7 @@ def _download_s3(self, links, location='.'):
         Assuming open access.
 
         Do not call directly.
-        Users should be using ~self.download_data instead
+        Users should be using `~self.download_data` instead
 
         """
         keys_list = [link for link in links['aws']]