fixed matplotlib.axes.Axes links

scverse · Apr 17, 2019 · b845c6e · b845c6e
1 parent 46062e5
commit b845c6e
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 10 deletions.
diff --git a/scanpy/plotting/_anndata.py b/scanpy/plotting/_anndata.py
@@ -608,7 +608,7 @@ def violin(adata, keys, groupby=None, log=False, use_raw=None, stripplot=True, j
 
     Returns
     -------
-    A `matplotlib.Axes` object if `ax` is `None` else `None`.
+    A :class:`~matplotlib.axes.Axes` object if `ax` is `None` else `None`.
     """
     sanitize_anndata(adata)
     if use_raw is None and adata.raw is not None: use_raw = True
@@ -809,7 +809,7 @@ def stacked_violin(adata, var_names, groupby=None, log=False, use_raw=None, num_
 
     Returns
     -------
-    List of `matplotlib.Axes`
+    List of :class:`~matplotlib.axes.Axes`
 
     Examples
     -------
@@ -1088,7 +1088,7 @@ def heatmap(adata, var_names, groupby=None, use_raw=None, log=False, num_categor
 
     Returns
     -------
-    List of `matplotlib.Axes`
+    List of :class:`~matplotlib.axes.Axes`
 
     Examples
     -------
@@ -1370,7 +1370,7 @@ def dotplot(adata, var_names, groupby=None, use_raw=None, log=False, num_categor
 
     Returns
     -------
-    List of `matplotlib.Axes`
+    List of :class:`~matplotlib.axes.Axes`
 
     Examples
     -------
@@ -1643,7 +1643,7 @@ def matrixplot(adata, var_names, groupby=None, use_raw=None, log=False, num_cate
 
     Returns
     -------
-    List of `matplotlib.Axes`
+    List of :class:`~matplotlib.axes.Axes`
 
     Examples
     --------
@@ -1843,7 +1843,7 @@ def tracksplot(adata, var_names, groupby, use_raw=None, log=False,
 
     Returns
     -------
-    A list of `matplotlib.Axes`.
+    A list of :class:`~matplotlib.axes.Axes`.
 
     Examples
     --------

diff --git a/scanpy/plotting/_qc.py b/scanpy/plotting/_qc.py
@@ -65,7 +65,7 @@ def highest_expr_genes(
 
     if not ax:
         # figsize is hardcoded to produce a tall image. To change the fig size,
-        # a matplotlib.Axes object needs to be passed.
+        # a matplotlib.axes.Axes object needs to be passed.
         height = (n_top * 0.2) + 1.5
         fig, ax = plt.subplots(figsize=(5, height))
     sns.boxplot(data=dat, orient='h', ax=ax, fliersize=1, **kwds)

diff --git a/scanpy/plotting/_tools/paga.py b/scanpy/plotting/_tools/paga.py
@@ -343,7 +343,7 @@ def paga(
         grouping.
     cmap : color map
         The color map.
-    cax : `matplotlib.Axes`
+    cax : :class:`~matplotlib.axes.Axes`
         A matplotlib axes object for a potential colorbar.
     cb_kwds : colorbar keywords
         See `here
@@ -362,7 +362,7 @@ def paga(
     save : `bool` or `str`, optional (default: `None`)
         If `True` or a `str`, save the figure. A string is appended to the
         default filename. Infer the filetype if ending on \\{'.pdf', '.png', '.svg'\\}.
-    ax : `matplotlib.Axes`
+    ax : :class:`~matplotlib.axes.Axes`
         A matplotlib axes object.
 
     Returns
@@ -867,7 +867,7 @@ def paga_path(
     save : `bool` or `str`, optional (default: `None`)
         If `True` or a `str`, save the figure. A string is appended to the
         default filename. Infer the filetype if ending on \\{'.pdf', '.png', '.svg'\\}.
-    ax : `matplotlib.Axes`
+    ax : :class:`~matplotlib.axes.Axes`
          A matplotlib axes object.
 
     Returns