-
Notifications
You must be signed in to change notification settings - Fork 1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Deleted all $ signs in code blocks in the "Composing multiple nodes in a single process" tutorial #2703
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So I agree with you that having the $
in here makes it not copy-n-pastable.
But the reason we left it like this on this tutorial is that these are really snippets showing a command and the result, not just a copy-n-paste command. We can definitely make this copyable, but if we are going to do that, we should split the result into a separate code-block, as you don't want to paste those into the terminal.
True, I think for the command results together with commands it makes sense. But it is not needed in the code blocks with only commands. If it won't affect a document stile too much I can put back |
We can think about the commands with results as console snapshots. Therefore |
The problem is that you then have this inconsistent state within the page where some blocks are copyable and some are not. I'd rather have them all be consistent within the page, one way or the other. Given what most of our other pages do, I think we should probably split them into separate command and result blocks across the board. |
I updated the file and squashed the commits. Can you please take another look? |
Deleted all $ signs in the code blocks and separated commands from outputs
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is fantastic, thanks for this update! Will merge and backport this.
@Mergifyio backport rolling galactic foxy |
Deleted all $ signs in the code blocks and separated commands from outputs (cherry picked from commit 1daab08)
Deleted all $ signs in the code blocks and separated commands from outputs (cherry picked from commit 1daab08)
Deleted all $ signs in the code blocks and separated commands from outputs (cherry picked from commit 1daab08) # Conflicts: # source/Tutorials/Intermediate/Composition.rst
✅ Backports have been created
|
Deleted all $ signs in the code blocks and separated commands from outputs (cherry picked from commit 1daab08) # Conflicts: # source/Tutorials/Intermediate/Composition.rst
$ signs prevent from effective use of "copy to clipboard" button. Previous tutorials don't have them in code blocks