From df6bb6c777cd3a42f467d1360e81026c1fee59be Mon Sep 17 00:00:00 2001 From: Libba Lawrence Date: Tue, 21 Jan 2025 13:28:31 -0800 Subject: [PATCH] should not manually edit (#39333) --- doc/dev/sample_guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/dev/sample_guide.md b/doc/dev/sample_guide.md index 0f3dc138b602..ec4f79f40458 100644 --- a/doc/dev/sample_guide.md +++ b/doc/dev/sample_guide.md @@ -51,7 +51,7 @@ The given `START`/`END` keywords can be used in a [sphinx literalinclude][sphinx [Literalinclude example][literalinclude] -The rendered code snippets are sensitive to the indentation in the sample file. Adjust the `dedent` accordingly to ensure the sample is captured accurately and not accidentally trimmed. +The rendered code snippets are sensitive to the indentation in the sample file. Sphinx will adjust the dedent accordingly to ensure the sample is captured accurately and not accidentally trimmed. You can preview how published reference documentation will look by running [tox][tox]: `tox run -e sphinx -c ../../../eng/tox/tox.ini --root `. ## Test run samples in CI live tests