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

doc: add flux-jobs(1) examples #3295

Merged
merged 2 commits into from
Nov 2, 2020

Conversation

chu11
Copy link
Member

@chu11 chu11 commented Oct 31, 2020

i elected not to cut & paste example output, as that can always change as we update things. Figured the sample command line options were enough.

Could add more ... ???

Copy link
Contributor

@grondo grondo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! I think this will be very helpful and it seems like a good starting list of examples that show the breadth of what could be done with flux-jobs.

I would just suggest that the commit titles be changed to be consistent. (Personally I don't feel with need to waste space with doc/man1/flux-jobs.rst: label since the commit itself explicitly tells you what files changed. Instead I'd tag each commit with simply doc: and have the rest of the title reference the change to flux-jobs(1) manpage)

Fix forgotten change in documentation in which --state should now
be --filter.
@chu11 chu11 force-pushed the issue3294_flux_jobs_examples branch from aa0c09c to 9b00510 Compare November 2, 2020 21:22
@chu11
Copy link
Member Author

chu11 commented Nov 2, 2020

@grondo thanks! i've re-pushed with tweaked commit titles

@chu11 chu11 force-pushed the issue3294_flux_jobs_examples branch from 9b00510 to 237c944 Compare November 2, 2020 21:25
@chu11
Copy link
Member Author

chu11 commented Nov 2, 2020

oh and i tweaked an example as the text did not perfectly match the example, "all jobids for the user" should go with the -a option not -A. (I could have instead tweaked the text to "all jobids of all users").

Copy link
Contributor

@grondo grondo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, LGTM!

@mergify mergify bot merged commit a638a7c into flux-framework:master Nov 2, 2020
@chu11 chu11 deleted the issue3294_flux_jobs_examples branch June 5, 2021 18:11
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.

2 participants