Skip to content

Commit 9b1b880

Browse files
authored
More doc tidying
* Update regrass.rst * Update cleaners.rst
1 parent 244e848 commit 9b1b880

2 files changed

Lines changed: 6 additions & 3 deletions

File tree

docs/plugins/cleaners.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,8 +105,8 @@ Options
105105
cleans contaminants *off* of items.
106106
``-g``, ``--grass``
107107
Remove unused (entirely depleted) grass events from map blocks. DF will
108-
create a grass events for each type of grass that grows in a block, but
109-
doesn't remove them if you pave over everything, or the grass got
108+
create a grass event for each type of grass that grows in a block, but
109+
doesn't remove them if you pave over the block or if the grass got
110110
depleted and entirely replaced with a different type. Could possibly
111111
improve FPS if you had a ton of unused grass events everywhere (a likely
112112
outcome of using ``regrass --new``). Requires ``--map`` option to be

docs/plugins/regrass.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,10 @@ Options
7878
``-n``, ``--new``
7979
Adds all biome-compatible grass types that were not originally present in
8080
the map block. Allows regrass to work in blocks that never had any grass to
81-
begin with. Will still fail in incompatible biomes.
81+
begin with. Will still fail in incompatible biomes. This can add an excessive
82+
amount of grass events to your map, so it may be desirable to run
83+
``clean --map --grass --only`` (see: `cleaners`) to clean up any unused events
84+
afterwards.
8285
``-f``, ``--force``
8386
Force a grass type on tiles with no compatible grass types. Unsets the
8487
``no_grow`` flag on all tiles. The ``--new`` option takes precedence for

0 commit comments

Comments
 (0)