docs: revert string formatting change of "jj help util exec" #5052
Conversation
This file contains 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
Appears that "cargo test" parses indented text as a code block, and fails to run doc tests. Spotted by running "cargo insta test". This doc comment is a CLI help which is usually rendered to console, so I think markdown annotation should be minimal. This backs out commit ed84468, "docs: in `jj help util exec`, use Markdown `warning` admonition."
arxanas
approved these changes
Dec 8, 2024
|
I don't think we rely on doc tests. I wouldn't notice the problem unless I ran |
I see. I opened #5056 to check docs in CI. |
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.
cc @arxanas
Checklist
If applicable:
CHANGELOG.md