Merge pull request #5701 from gorshunovr/patch-2

Update flags documentation
readthedocs · Jun 5, 2019 · aa2cd18 · aa2cd18
2 parents c64af2d + 130b2d4
commit aa2cd18
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/docs/guides/feature-flags.rst b/docs/guides/feature-flags.rst
@@ -18,4 +18,8 @@ Available Flags
 
 ``DONT_SHALLOW_CLONE``: :featureflags:`DONT_SHALLOW_CLONE`
 
-``USE_TESTING_BUILD_IMAGE``: :featureflags:`USE_TESTING_BUILD_IMAGE`
+The ``DONT_SHALLOW_CLONE`` flag is useful if your code accesses old commits during docs build,
+e.g. python-reno release notes manager is known to do that
+(error message line would probably include one of old Git commit id's).
+
+``USE_TESTING_BUILD_IMAGE``: :featureflags:`USE_TESTING_BUILD_IMAGE`