Add stable cf-docs snippet tags#5732
Open
danielporterda wants to merge 3 commits into
Open
Conversation
8be6e93 to
2eca7a0
Compare
Contributor
|
(see slack, I don't understand what we're trying to do. These snippets are no longer maintained in Splice, so why do we care about tagging them??) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds stable
CF_DOCS_SPLICE_SNIPPET_*RST comment tags around the Splice documentation ranges consumed by cf-docs external snippet generation. This lets cf-docs extract snippets by source tags instead of brittle line numbers.Six implicit literal blocks are converted to explicit
code-blockdirectives so the tag comments can wrap the exact snippet body cleanly without changing the rendered intent. I also fixed one adjacent inline-literal spacing typo caught bysphinx-lint.Confirmed that existing docs generation still works.