DOC: Fix references in contribution guides.

QuLogic · QuLogic · commit 3656ac5b23e8 · 2020-09-03T17:01:26.000-04:00
diff --git a/doc/api/testing_api.rst b/doc/api/testing_api.rst
@@ -3,6 +3,11 @@
 **********************
 
 
+:func:`matplotlib.test`
+=======================
+
+.. autofunction:: matplotlib.test
+
 :mod:`matplotlib.testing`
 =========================
 
diff --git a/doc/devel/contributing.rst b/doc/devel/contributing.rst
@@ -409,29 +409,26 @@ C/C++ extensions
 Keyword argument processing
 ---------------------------
 
-Matplotlib makes extensive use of ``**kwargs`` for pass-through
-customizations from one function to another.  A typical example is in
-:func:`matplotlib.pyplot.text`.  The definition of the pylab text
-function is a simple pass-through to
-:meth:`matplotlib.axes.Axes.text`::
+Matplotlib makes extensive use of ``**kwargs`` for pass-through customizations
+from one function to another. A typical example is in `matplotlib.pyplot.text`.
+The definition of the pylab text function is a simple pass-through to
+`matplotlib.axes.Axes.text`::
 
   # in pylab.py
   def text(*args, **kwargs):
       ret = gca().text(*args, **kwargs)
       draw_if_interactive()
       return ret
 
-:meth:`~matplotlib.axes.Axes.text` in simplified form looks like this,
-i.e., it just passes all ``args`` and ``kwargs`` on to
-:meth:`matplotlib.text.Text.__init__`::
+`~matplotlib.axes.Axes.text` in simplified form looks like this, i.e., it just
+passes all ``args`` and ``kwargs`` on to ``matplotlib.text.Text.__init__``::
 
   # in axes/_axes.py
   def text(self, x, y, s, fontdict=None, withdash=False, **kwargs):
       t = Text(x=x, y=y, text=s, **kwargs)
 
-and :meth:`~matplotlib.text.Text.__init__` (again with liberties for
-illustration) just passes them on to the
-:meth:`matplotlib.artist.Artist.update` method::
+and ``matplotlib.text.Text.__init__`` (again with liberties for illustration)
+just passes them on to the `matplotlib.artist.Artist.update` method::
 
   # in text.py
   def __init__(self, x=0, y=0, text='', **kwargs):
@@ -471,10 +468,10 @@ local arguments and the rest are passed on as
 Using logging for debug messages
 --------------------------------
 
-Matplotlib uses the standard python `logging` library to write verbose
-warnings, information, and
-debug messages.  Please use it!  In all those places you write :func:`print()`
-statements to do your debugging, try using :func:`log.debug()` instead!
+Matplotlib uses the standard Python `logging` library to write verbose
+warnings, information, and debug messages. Please use it! In all those places
+you write `print` calls to do your debugging, try using `logging.debug`
+instead!
 
 
 To include `logging` in your module, at the top of the module, you need to
@@ -489,8 +486,8 @@ To include `logging` in your module, at the top of the module, you need to
 
 will log to a logger named ``matplotlib.yourmodulename``.
 
-If an end-user of Matplotlib sets up `logging` to display at levels
-more verbose than `logging.WARNING` in their code with the Matplotlib-provided
+If an end-user of Matplotlib sets up `logging` to display at levels more
+verbose than ``logging.WARNING`` in their code with the Matplotlib-provided
 helper::
 
   plt.set_loglevel("debug")
@@ -527,7 +524,7 @@ There are five levels at which you can emit messages.
   steps of layouting or rendering) should only log at this level.
 
 By default, `logging` displays all log messages at levels higher than
-`logging.WARNING` to `sys.stderr`.
+``logging.WARNING`` to `sys.stderr`.
 
 The `logging tutorial`_ suggests that the difference between `logging.warning`
 and `.cbook._warn_external` (which uses `warnings.warn`) is that
@@ -537,11 +534,11 @@ persistent. Moreover, note that `.cbook._warn_external` will by default only
 emit a given warning *once* for each line of user code, whereas
 `logging.warning` will display the message every time it is called.
 
-By default, `warnings.warn` displays the line of code that has the `warn` call.
-This usually isn't more informative than the warning message itself. Therefore,
-Matplotlib uses `.cbook._warn_external` which uses `warnings.warn`, but goes
-up the stack and displays the first line of code outside of Matplotlib.
-For example, for the module::
+By default, `warnings.warn` displays the line of code that has the ``warn``
+call. This usually isn't more informative than the warning message itself.
+Therefore, Matplotlib uses `.cbook._warn_external` which uses `warnings.warn`,
+but goes up the stack and displays the first line of code outside of
+Matplotlib. For example, for the module::
 
     # in my_matplotlib_module.py
     import warnings
@@ -582,10 +579,9 @@ and running the same script will display::
 Writing examples
 ----------------
 
-We have hundreds of examples in subdirectories of
-:file:`matplotlib/examples`, and these are automatically generated
-when the website is built to show up in the `examples
-<../gallery/index.html>` section of the website.
+We have hundreds of examples in subdirectories of :file:`matplotlib/examples`,
+and these are automatically generated when the website is built to show up in
+the :ref:`examples <gallery>` section of the website.
 
 Any sample data that the example uses should be kept small and
 distributed with Matplotlib in the
diff --git a/doc/devel/testing.rst b/doc/devel/testing.rst
@@ -91,7 +91,7 @@ Writing a simple test
 ---------------------
 
 Many elements of Matplotlib can be tested using standard tests. For
-example, here is a test from :mod:`matplotlib.tests.test_basic`::
+example, here is a test from :file:`matplotlib/tests/test_basic.py`::
 
   def test_simple():
       """
@@ -105,7 +105,7 @@ begin with ``"test_"`` and then within those files for functions beginning with
 
 Some tests have internal side effects that need to be cleaned up after their
 execution (such as created figures or modified `.rcParams`). The pytest fixture
-:func:`~matplotlib.testing.conftest.mpl_test_settings` will automatically clean
+``matplotlib.testing.conftest.mpl_test_settings`` will automatically clean
 these up; there is no need to do anything further.
 
 Random data in tests
diff --git a/doc/missing-references.json b/doc/missing-references.json
@@ -416,9 +416,6 @@
     ]
   },
   "py:func": {
-    "log.debug": [
-      "doc/devel/contributing.rst:450"
-    ],
     "matplotlib.Axis.set_ticks_position": [
       "doc/users/prev_whats_new/whats_new_1.4.rst:141"
     ],
@@ -427,12 +424,6 @@
     ],
     "matplotlib.axis.Tick.label1On": [
       "doc/users/prev_whats_new/whats_new_2.1.0.rst:409"
-    ],
-    "matplotlib.test": [
-      "doc/devel/testing.rst:79"
-    ],
-    "matplotlib.testing.conftest.mpl_test_settings": [
-      "doc/devel/testing.rst:106"
     ]
   },
   "py:meth": {
@@ -502,10 +493,6 @@
     "matplotlib.patches.Rectangle.contains": [
       "doc/users/event_handling.rst:164"
     ],
-    "matplotlib.text.Text.__init__": [
-      "doc/devel/contributing.rst:400",
-      "doc/devel/contributing.rst:408"
-    ],
     "option_scale_image": [
       "lib/matplotlib/backends/backend_cairo.py:docstring of matplotlib.backends.backend_cairo.RendererCairo.draw_image:22",
       "lib/matplotlib/backends/backend_pdf.py:docstring of matplotlib.backends.backend_pdf.RendererPdf.draw_image:22",
@@ -552,15 +539,9 @@
     ],
     "matplotlib.ft2font": [
       "doc/api/prev_api_changes/api_changes_0.91.0.rst:34"
-    ],
-    "matplotlib.tests.test_basic": [
-      "doc/devel/testing.rst:93"
     ]
   },
   "py:obj": {
-    "./gallery/index.html": [
-      "doc/devel/contributing.rst:562"
-    ],
     "Artist.stale_callback": [
       "doc/users/interactive_guide.rst:326"
     ],
@@ -898,10 +879,6 @@
     "load_char": [
       "doc/gallery/misc/ftface_props.rst:16"
     ],
-    "logging.WARNING": [
-      "doc/devel/contributing.rst:468",
-      "doc/devel/contributing.rst:505"
-    ],
     "mainloop": [
       "lib/matplotlib/backends/backend_nbagg.py:docstring of matplotlib.backends.backend_nbagg.show:4"
     ],
@@ -1403,9 +1380,6 @@
     "w_pad": [
       "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.set_constrained_layout:5"
     ],
-    "warn": [
-      "doc/devel/contributing.rst:517"
-    ],
     "whats_new.rst": [
       "doc/users/next_whats_new/README.rst:6"
     ],
