coral2: change rabbit docs to use -S flag #277
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Problem: flux-core PR github.com/flux-framework/flux-core/pull/6238 introduced the `-S` option as shorthand for `--setattr`, and users will most likely prefer using `-S`, but only `--setattr` is described in the documentation. Change the documentation to list both options and make the examples use `-S`.
grondo
approved these changes
Sep 3, 2024
There was a problem hiding this comment.
LGTM!
It is a style choice, and I'm sure you're already aware, but since -S requires an argument, no space is necessary between -S and dw, so
$ flux alloc -N2 -Sdw="#DW jobdw type=xfs capacity=10GiB name=project1
will work too.
Just pointing that out in case it wasn't obvious :-)
|
Yeah I was thinking users might find it easier to read maybe? |
|
Yes, good point. I wasn't suggesting any changes, just making sure we didn't think a space between |
|
Makes sense. Thanks for the review! Setting MWP. |
jameshcorbett
added
the
merge-when-passing
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem: flux-core PR github.com/flux-framework/flux-core/pull/6238 introduced the
-Soption as shorthand for--setattr, and users will most likely prefer using-S, but only--setattris described in the documentation.Change the documentation to list both options and make the examples use
-S.