Added links to the mosaic docs in figure and pyplot module docstrings (#21546)

Sven Eschlbeck · web-flow · commit 49abfef9709e · 2021-11-07T17:12:00.000+01:00
* Added links to the mosaic docs in figure and pyplot module docstrings

* I got rid of some whitespaces and dropped the fileending at the end of the link

* I changed the comment a bit in the docstrings

* I changed the comment describing the purpose of the link
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -1679,6 +1679,9 @@ def subplot_mosaic(self, mosaic, *, sharex=False, sharey=False,
            This API is provisional and may be revised in the future based on
            early user feedback.
 
+        See :doc:`/tutorials/provisional/mosaic`
+        for an example and full API documentation
+
         Parameters
         ----------
         mosaic : list of list of {hashable or nested} or str
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -1451,6 +1451,9 @@ def subplot_mosaic(mosaic, *, sharex=False, sharey=False,
        This API is provisional and may be revised in the future based on
        early user feedback.
 
+    See :doc:`/tutorials/provisional/mosaic`
+    for an example and full API documentation
+
     Parameters
     ----------
     mosaic : list of list of {hashable or nested} or str
