Don’t treat docs as transcripts #5903
Merged
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.
Overview
transcriptshad run against all Markdown files in the repo to do a basic sanity check on anything that might contain transcript stanzas. However, for docs, it’s useful to make quick edits directly on GitHub, which meant the golden files wouldn’t get updated, and the transcript tests would fail after the change.This removes
transcriptschecking on thedocsfolder to allow GitHub edits of those files.Test coverage
This ostensibly removes test coverage of some Markdown files, but there are few stanzas that would be picked up as transcripts, and they’re only used for syntax highlighting.
If demonstrations of transcripts were added to
docs, they would likely be nested withinmarkdownblocks, likewhich wouldn’t be picked up by the transcript tests anyway.