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

Improve copy of console command examples #5355

Closed
zanieb opened this issue Jul 23, 2024 · 0 comments · Fixed by #5397
Closed

Improve copy of console command examples #5355

zanieb opened this issue Jul 23, 2024 · 0 comments · Fixed by #5397
Labels
documentation Improvements or additions to documentation

Comments

@zanieb
Copy link
Member

zanieb commented Jul 23, 2024

e.g.

$ uv foo

cannot be copy pasted without the leading $ in the documentation.

See PrefectHQ/prefect#9204 for a bunch of discussion about this problem and potential solutions.

A possible solution is to use bash syntax instead and omit the $ entirely, but this looses the context that a command is intended to be executed in a terminal :(

@zanieb zanieb added the documentation Improvements or additions to documentation label Jul 23, 2024
@zanieb zanieb closed this as completed in 8994768 Jul 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant