Skip to content

Commit

Permalink
Update bots.rst [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
danieljprice committed Aug 4, 2023
1 parent 0814b57 commit dafed97
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/bots.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ or when looking at who wrote particular lines in VSCode. Otherwise a small
adjustment in indentation means the lines will be attributed to someone else...

performing a dry run
~~~~~~~~~~~~~~~~~~~~~
---------------------

By default the bots perform a dry run, making no changes but showing you
what will be changed when you apply the changes.
Expand All @@ -26,7 +26,7 @@ You can run the bots yourself as follows::
./bots.sh

doing it for real
~~~~~~~~~~~~~~~~~~~~~
---------------------

If you are happy with the dry run, and you have a clean repository (i.e. everything
is committed onto the current branch you are working on), proceed to ACTUALLY
Expand All @@ -41,7 +41,7 @@ of phantom your push will be disallowed. Instead you should push the changes
to your fork and issue a pull request.

apply but do not commit
~~~~~~~~~~~~~~~~~~~~~~~~
-----------------------

In some circumstances you want to apply the changes to the files but leave them
as "modified" in the current directory, which means that the can be reversed
Expand All @@ -51,7 +51,7 @@ with "git restore" and/or committed manually::
./bots.sh --apply

running only specific bots
~~~~~~~~~~~~~~~~~~~~~~~~~~
--------------------------

You can run specific bots using the --only flag, e.g.::

Expand All @@ -64,7 +64,7 @@ or, to run multiple (or all)::
./bots.sh --apply --only "tabs gt shout header whitespace authors endif"

fixing merge conflicts in the AUTHORS file
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-------------------------------------------

you can easily recreate/update the AUTHORS file using the authors bot::

Expand Down

0 comments on commit dafed97

Please sign in to comment.