Skip to content

Commit 9997271

Browse files
committed
Update flags documentation
Update flags documentation with information on when DONT_SHALLOW_CLONE could be useful.
1 parent 0bac470 commit 9997271

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/guides/feature-flags.rst

+4
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,7 @@ Available Flags
2727
``MKDOCS_THEME_RTD``: :featureflags:`MKDOCS_THEME_RTD`
2828

2929
``DONT_SHALLOW_CLONE``: :featureflags:`DONT_SHALLOW_CLONE`
30+
31+
The ``DONT_SHALLOW_CLONE`` flag is useful if your code accesses old commits during docs build,
32+
e.g. python-reno release notes manager is known to do that
33+
(error message line would probably include one of old Git commit id's).

0 commit comments

Comments
 (0)