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

[UX] Split README's install code block into 3 #8853

Merged
merged 4 commits into from
Nov 8, 2024

Conversation

willingc
Copy link
Contributor

@willingc willingc commented Nov 6, 2024

  • Broke up the large code block into 3 blocks so that copy paste icon works

Howdy Astral friends! This is a small PR which is a small user experience improvement for smooth installs.

- Broke up the large code block into 3 blocks so that copy paste icon works
@zanieb
Copy link
Member

zanieb commented Nov 7, 2024

Won't the copy paste fail because of the leading $ anyway?

@zanieb
Copy link
Member

zanieb commented Nov 7, 2024

For some more context, in #5397 we made it so that the $ is stripped from copied console commands in the documentation but that doesn't apply to the README. I think we'll need to move the comments and $ out of the code blocks to achieve the desired effect here.

Nice to see you Carol! Thanks for taking the time to contribute :)

@willingc
Copy link
Contributor Author

willingc commented Nov 7, 2024

I'm not sure about the $. But I figured that I would mention it since the copy paste grabbed all of lines and made the shell grumpy. Good to see you virtually too.

@zanieb
Copy link
Member

zanieb commented Nov 7, 2024

I gave it a try in the preview and we'll need to change that before we can merge. I can futz with it sometime soon if you don't want to.

@willingc
Copy link
Contributor Author

willingc commented Nov 7, 2024

It does fail if you keep the preceding $. I've removed the $ and switched the syntax highlighting to bash. I'm able to copy-paste fine on Mac. YMMV on Windows (I don't have a good test machine for that.) @zanieb

@zanieb
Copy link
Member

zanieb commented Nov 8, 2024

Thank you!

@zanieb zanieb added the documentation Improvements or additions to documentation label Nov 8, 2024
@zanieb zanieb merged commit 705b6cd into astral-sh:main Nov 8, 2024
53 checks passed
@willingc willingc deleted the patch-1 branch November 8, 2024 00:14
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 this pull request may close these issues.

2 participants