Skip to content

Commit dcd6c28

Browse files
committed
Rewording in configuration docs.
1 parent f29d037 commit dcd6c28

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

docs/configuration.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,12 @@ collections_clean
4444

4545
If ``True`` all configured target locations get wiped out at the beginning.
4646

47-
The related driver of the collection decides, if and clean is needed and how it must be performed.
47+
The related driver of the collection specifies if cleaning is needed and how to perform it.
4848

4949
If you use nested collections, e.g ``_collections/collection_A/collection_B`` the outer clean routine of
5050
a collection (here ``collection_A``) deletes also the content of other collections (here ``collection_B``).
5151

52-
Can be overwritten for each collection be setting :ref:`collections_clean`.
52+
This can be overwritten for each collection be configuring :ref:`collections_clean`.
5353

5454
**Default**: ``True``
5555

@@ -60,10 +60,11 @@ Can be overwritten for each collection be setting :ref:`collections_clean`.
6060
collections_final_clean
6161
-----------------------
6262

63-
If ``True`` all collections start their clean-up routine after a Sphinx build is done.
64-
Normally It doesn't matter if the build was an success or stopped.
63+
If this option is set to ``True``, all collections start their clean-up
64+
routine after a Sphinx build is done. Normally It doesn't matter if
65+
the build was a success or failed.
6566

66-
Works similar to :ref:`conf_collections_clean`, but at the end of the build instead before.
67+
Works similarly to :ref:`conf_collections_clean`, but at the end of the build instead before.
6768

6869
Can be overwritten for each collection be setting :ref:`collections_final_clean`.
6970

0 commit comments

Comments
 (0)