Skip to content

Commit

Permalink
should not manually edit (Azure#39333)
Browse files Browse the repository at this point in the history
  • Loading branch information
l0lawrence authored Jan 21, 2025
1 parent 6192f6d commit df6bb6c
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/dev/sample_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <path to python package>`.

## Test run samples in CI live tests
Expand Down

0 comments on commit df6bb6c

Please sign in to comment.