Update flags documentation

gorshunovr · web-flow · commit 9d5f19d87105 · 2019-05-15T17:09:45.000+02:00
Update flags documentation with information on when DONT_SHALLOW_CLONE could be useful.
diff --git a/docs/guides/feature-flags.rst b/docs/guides/feature-flags.rst
@@ -26,4 +26,4 @@ Available Flags
 
 ``MKDOCS_THEME_RTD``: :featureflags:`MKDOCS_THEME_RTD`
 
-``DONT_SHALLOW_CLONE``: :featureflags:`DONT_SHALLOW_CLONE`
+``DONT_SHALLOW_CLONE``: :featureflags:`DONT_SHALLOW_CLONE` This 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).

Original file line number	Diff line number	Diff line change
`@@ -26,4 +26,4 @@ Available Flags`
`26`	`26`
`27`	`27`	``MKDOCS_THEME_RTD``: :featureflags:`MKDOCS_THEME_RTD`
`28`	`28`
`29`		-``DONT_SHALLOW_CLONE``: :featureflags:`DONT_SHALLOW_CLONE`
	`29`	+``DONT_SHALLOW_CLONE``: :featureflags:`DONT_SHALLOW_CLONE` This 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).