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 explicitness of help doc of --command on rez-env #1682

Merged

Conversation

brycegbrazen
Copy link
Contributor

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

@brycegbrazen brycegbrazen requested a review from a team as a code owner March 12, 2024 16:08
Copy link

codecov bot commented Mar 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

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

Additional details and impacted files
@@           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           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@bpabel
Copy link
Contributor

bpabel commented Mar 12, 2024

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

  • "read" is a poor verb choice; all arguments are read. "execute" would be a better verb.
  • denoting it as a "string" is redundant, all commands are strings.
  • "command arguments" is misleading; it's actually a full command and command arguments.

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
Copy link
Contributor

bpabel commented Mar 12, 2024

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.

@bpabel bpabel self-assigned this Mar 12, 2024
@bpabel bpabel added enhancement documentation shell Shell related issues and removed shell Shell related issues labels Mar 12, 2024
Signed-off-by: brycegbrazen <[email protected]>
@bpabel bpabel merged commit c216f9d into AcademySoftwareFoundation:main Mar 14, 2024
53 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants