Skip to content

Conversation

@haim0n
Copy link

@haim0n haim0n commented Nov 28, 2022

No description provided.

@jorisvandenbossche
Copy link
Member

@haim0n Thanks for the contribution. I am wondering though, is there a specific reason for this? We have other code blocks on this page that also consist of multiple commands, and where we also don't do this.

@haim0n
Copy link
Author

haim0n commented Nov 30, 2022

@jorisvandenbossche , you're right. I walked the path of the newbie setting up the dev env for the first time. So the one liner was a speedup for me (replaces 3 copy/paste actions) and allows to skip this mechanical step.

Some of the other commands contain comments between them and provide some learning curve to new comers- so my guess they're nice to have and probably should be left intact.

@jorisvandenbossche
Copy link
Member

I walked the path of the newbie setting up the dev env for the first time. So the one liner was a speedup for me (replaces 3 copy/paste actions) and allows to skip this mechanical step.

That's of course something a newcomer also doesn't necessarily know, but you can actually copy paste those three lines at once (at least most terminals should support executing those one by one if pasting multiple lines)

@haim0n
Copy link
Author

haim0n commented Dec 1, 2022

mmm no - Bash treats $ as variable and those lines can't be just pasted.

@pitrou
Copy link
Member

pitrou commented Dec 5, 2022

I don't really like this change. It makes the snippet easier to paste, but at the expense of readability.

@raulcd
Copy link
Member

raulcd commented Dec 20, 2022

For completeness, if you are navigating the documentation: https://arrow.apache.org/docs/developers/python.html#environment-setup-and-build
and try to copy & paste or use the sphinx copy to clipboard button it already skips the $. This is what my clipboard copies:

pushd arrow
git submodule update --init
export PARQUET_TEST_DATA="${PWD}/cpp/submodules/parquet-testing/data"
export ARROW_TEST_DATA="${PWD}/testing/data"
popd

If you try to copy directly from the source rst file, yes, you have to copy&paste for each command because the $ gets copied to the clipboard but that should be ok.

@amol-
Copy link
Member

amol- commented Mar 30, 2023

Closing because it has been untouched for a while, in case it's still relevant feel free to reopen and move it forward 👍

@amol- amol- closed this Mar 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants