DOC: Add development release note and note to add type hints into coding guide

ksunden · ksunden · commit 6400bd763b97 · 2023-03-29T16:04:07.000-05:00
diff --git a/doc/api/next_api_changes/development/24976-KS.rst b/doc/api/next_api_changes/development/24976-KS.rst
@@ -0,0 +1,18 @@
+Provisional support for PEP484 Type Hint Annotations
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+New public API should be type hinted in ``.pyi`` stub files (except ``pyplot`` and tests
+which are typed in-line).
+Tests should be type hinted minimally, essentially only when ``mypy`` generates errors.
+
+CI and configuration for running ``mypy`` have been added.
+
+
+Generation of ``pyplot.py`` requires ``black``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The autogenerated portions of ``pyplot.py`` use ``black`` autoformatting to ensure
+syntax-correct, readable output code.
+
+As such ``black`` is now a development and test requirement (for the test which
+regenerates ``pyplot``).
diff --git a/doc/devel/coding_guide.rst b/doc/devel/coding_guide.rst
@@ -82,6 +82,11 @@ rules before submitting a pull request:
   by the contributor's initials. (see :file:`doc/api/api_changes.rst` for more
   information)
 
+* If you add new public API or change public API, update or add the
+  corresponding type hints. Most often this is found in the corresponding
+  ``.pyi`` file for the ``.py`` file which was edited. Changes in ``pyplot.py``
+  are type hinted inline.
+
 * See below for additional points about :ref:`keyword-argument-processing`, if
   applicable for your pull request.
 
