From 1eca4c8669e1f421eb35b78996007d3803b1587b Mon Sep 17 00:00:00 2001 From: Derick Rethans Date: Tue, 28 May 2024 18:15:32 +0100 Subject: [PATCH] Explain how to format these documents --- README.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.rst b/README.rst index 4279b12..6fc5621 100644 --- a/README.rst +++ b/README.rst @@ -26,3 +26,20 @@ It contains the following items: and process on how and when to update the `security.txt `_ file on https://www.php.net. + +************ + Formatting +************ + +The files in this documentation are formatted using the `rstfmt +`_ tool, which you can install with: + +.. code:: + + pip install rstfmt + +Please run the tool before submitting a pull request: + +.. code:: + + rstfmt -w 80 *.rst