Skip to content

Commit aa2cd18

Browse files
authored
Merge pull request #5701 from gorshunovr/patch-2
Update flags documentation
2 parents c64af2d + 130b2d4 commit aa2cd18

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/guides/feature-flags.rst

+5-1
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,8 @@ Available Flags
1818

1919
``DONT_SHALLOW_CLONE``: :featureflags:`DONT_SHALLOW_CLONE`
2020

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

0 commit comments

Comments
 (0)