Skip to content

Commit

Permalink
Explain how to format these documents
Browse files Browse the repository at this point in the history
  • Loading branch information
derickr committed Sep 18, 2024
1 parent 8c91da3 commit ec7fc1b
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,20 @@ It contains the following items:
and process on how and when to update the `security.txt
<https://www.php.net/.well-known/security.txt>`_ file on
https://www.php.net.

************
Formatting
************

The files in this documentation are formatted using the `rstfmt
<https://github.com/dzhu/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

0 comments on commit ec7fc1b

Please sign in to comment.