Skip to content

Conversation

@lifehackett
Copy link

Summary

Improve the docs and make getting started easier. Move the comments on which environment/tool to use out of the code blocks so you can copy and paste directly into the terminal

@zanieb
Copy link
Member

zanieb commented Dec 6, 2024

These should be copy-pastable into the terminal already.

See the previous change that touched these blocks #8853

@zanieb
Copy link
Member

zanieb commented Dec 6, 2024

Did these not work as-is for you? It may still be reasonable to move the comments out, I think it just consumes more space in the README that way.

@lifehackett
Copy link
Author

Retried and it worked. Looked at the previous failure and I had a lingering character that I missed. I prefer to copy/paste without the comment, but that's just personal preference. It's your repo, so happy to close this

@zanieb
Copy link
Member

zanieb commented Dec 6, 2024

Just for comparison-sake

Screenshot 2024-12-06 at 9 21 10 AM

The vertical space consumption is negligible imo, but I don't prefer the readability / styling. I'm not sure how we could improve that.

@lifehackett
Copy link
Author

Checked a few places to compare

Headers & bullets
https://github.com/pypa/pipx?tab=readme-ov-file#install-pipx

Uses a table format at the expense of copy/paste
https://github.com/ohmyzsh/ohmyzsh?tab=readme-ov-file#basic-installation

Poetry & Httpie refer you to their docs site

@konstin
Copy link
Member

konstin commented Apr 28, 2025

Closing this PR, since we're unlikely to change this for now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants