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

Minor documentation updates for consistency and clarity #62

Merged

Conversation

sadielbartholomew
Copy link
Member

Quick one to make some minor formatting updates, mostly for the command-line help descriptions (I went in to update the documentation README and thought I should include these updates), namely:

  • instead of listing the documentation build requirements in the README, pointing to the new docs-requirements.txt file created in docs: cli reference #60 so we don't have two equivalent lists to keep in sync;
  • being more consistent in the command-line descriptions by, e.g., using only single quotes around all keywords (means the generated CLI reference emphasises them via italics but avoiding double quotes which will clutter the terminal --help output) and listing defaults at the end;
  • adding default information for --jobinfo which was missing before, to be explicit and clear;
  • capitalising the first word from one docstring which was inconsistent with the others coming through in the API reference.

@sadielbartholomew sadielbartholomew added the documentation Improvements or additions to documentation label Sep 12, 2023
@sadielbartholomew
Copy link
Member Author

sadielbartholomew commented Sep 12, 2023

(Pretty trivial PR to review, so open to anyone as reviewer and won't take long. Thanks!)

Copy link
Collaborator

@andreww andreww left a comment

Choose a reason for hiding this comment

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

Looks good to me.

@andreww andreww merged commit ef0e308 into GreenScheduler:main Sep 14, 2023
3 checks passed
@sadielbartholomew sadielbartholomew deleted the user-facing-descrip-formatting branch September 14, 2023 10:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants