Skip to content
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

clarity for usage as an example: "$" #18

Open
bnord opened this issue May 9, 2023 · 4 comments
Open

clarity for usage as an example: "$" #18

bnord opened this issue May 9, 2023 · 4 comments
Assignees
Labels
question Further information is requested
Milestone

Comments

@bnord
Copy link
Contributor

bnord commented May 9, 2023

Should we lines with "$" or should make it trivially copy/paste?

The current code blocks can't be copy-pasted into a CLI.

do each of the following commands in order ($ means new line):

@bnord bnord added the question Further information is requested label May 9, 2023
@bnord bnord added this to the alpha milestone May 9, 2023
@voetberg
Copy link
Collaborator

voetberg commented May 9, 2023

You can do that by just making a block with ```
(ex:

I am making a code block that is copypaste
This is the second line that has a \n attached implicitly
If you paste this it runs as 3 different lines

)

@bnord bnord reopened this May 9, 2023
@bnord
Copy link
Contributor Author

bnord commented May 9, 2023

How should we display the outputs that are expected?

@samueldmcdermott
Copy link

sorry, for what? I thought this referred to the Jupyter notebook discussion, which is no longer there

@bnord
Copy link
Contributor Author

bnord commented May 27, 2023

I meant the outputs that are expected from a given use of a code snippet. Where $ used to be.

Are there any code snippets that have potentially confusing outputs?

@bnord bnord reopened this May 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

3 participants