René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"[Doc]: clarify when and how to use boilerplate.py","articleBody":"### Documentation Link\r\n\r\n_No response_\r\n\r\n### Problem\r\n\r\nPer this discussion https://github.com/matplotlib/matplotlib/pull/27158#discussion_r1371803287, I (maybe other folk) are a bit confused on what the \"do not edit\" comments in pyplot mean given that [boilerplate.py](https://github.com/matplotlib/matplotlib/blob/main/tools/boilerplate.py) is never run automatically. Consensus seems to be that the process should be `when changing the signature of a pyplot function, run boilerplate.py and commit those changes` but that's not documented anywhere. \r\n\r\n### Suggested improvement\r\n\r\nMore clearly document using boilerplate.py by:\r\n1) changing the Autogen message to \"generated by biolerplate.py, do not edit\"\r\nhttps://github.com/matplotlib/matplotlib/blob/b86e3312f8bc52a342362c6104c2d46a51f7e943/tools/boilerplate.py#L61-L64\r\n2) change the comment at the top of pyplot to something like \"plotting signatures are generated by boilerplate.py, rerun when changing signatures and commit the changes\r\nhttps://github.com/matplotlib/matplotlib/blob/b86e3312f8bc52a342362c6104c2d46a51f7e943/lib/matplotlib/pyplot.py#L1-L2\r\n3) add something like (note: this rst may be incorrect)  to the coding guideline. \r\n```rst\r\nWhen a function in the :doc:`pyplot  API\u003cdoc/api/pyplot_summary\u003e`, run :file:`lib/matplotlib/test_pyplot.py::test_pyplot_up_to_date`. If the test fails and and you intended to change those signatures, run boilerplate.py and commit the changes\r\n```","author":{"url":"https://github.com/story645","@type":"Person","name":"story645"},"datePublished":"2023-10-25T16:23:35.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":1},"url":"https://github.com/27190/matplotlib/issues/27190"}