Update code blocks and add guidelines on usage to style guide #74
Conversation
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
- Use console instead of terminal - Use bash when there's no output
|
preview available: https://docs.tds.cscs.ch/74 |
Merged
bcumming
requested changes
Apr 3, 2025
Member
bcumming
left a comment
bcumming
left a comment
There was a problem hiding this comment.
Great!
My only suggested improvement is to document the use of $ for "user prompt" in console/bash examples.
Co-authored-by: Ben Cumming <bcumming@cscs.ch>
|
preview available: https://docs.tds.cscs.ch/74 |
|
preview available: https://docs.tds.cscs.ch/74 |
bcumming
approved these changes
Apr 3, 2025
Member
|
Thanks @msimberg! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
I've attempted to fix up some code blocks. Whatever was obviously a terminal (ehm, console) session I've updated to use
console. Turns outterminalisn't a valid lexer, and just does no highlighting. I've changed some types tobashorconsolea bit depending on the contents of the code block, but I have not tried to fix everything.I've added a section about code blocks to the style guide, which we can try to follow when updating existing or adding new docs.