Repository navigation
refactor: correct the documented term-recording output path - #445
Merged
Merged
Conversation
…guard The term-recording pre-render docstring said recordings render into `great-docs/termshow/`. They render into `termshow/` under the build directory, which is not always named `great-docs`. Correct the docstring and document its logger parameter. The term player imports only the standard library and a hard dependency of the package, so the `ImportError` guard around its import could not fire. Remove it. Behaviour is unchanged.
📚 Preview this PR's docs locallyFetch the just-built site and open it in your browser: # this exact build
great-docs preview --run 40541908237
# or always the latest build for this PR
great-docs preview --pr 445Auth & tips
|
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.
This PR corrects the docstring of the build step that pre-renders
.termshowrecordings, and removes an import guard around the term player. The docstring said recordings render intogreat-docs/termshow/, but they go intotermshow/under the build directory, which is not always namedgreat-docs. The guard caught anImportErrorthat cannot happen: the term player imports only the standard library and a hard dependency.