AcademySoftwareFoundation / rez

An integrated package configuration, build and deployment system for software
https://rez.readthedocs.io
Apache License 2.0
932 stars 329 forks source link

Improve explicitness of help doc of --command on rez-env #1682

Closed brycegbrazen closed 5 months ago

brycegbrazen commented 5 months ago

Felt like this explicit mention of non-interactivity is helpful for users new to Rez.

codecov[bot] commented 5 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 58.05%. Comparing base (dc2c777) to head (ee4e056).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #1682 +/- ## ======================================= Coverage 58.05% 58.05% ======================================= Files 126 126 Lines 17035 17035 Branches 3490 3490 ======================================= Hits 9889 9889 Misses 6482 6482 Partials 664 664 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

bpabel commented 5 months ago

Thanks for your recommendation! I agree it could be better worded. A few things I think could be improved:

Something like "Execute command within rez environment and exit..." would be better, plus your other additions (also, replace "command arguments" with just "command")

Would you mind updating?

bpabel commented 5 months ago

Also, something I just realized, the command and arguments passed to -c must be passed in as a single shell argument, whereas the command and arguments after -- are all passed in as separate shell arguments.

That should probably be noted somehow in the help text.