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

Update and clarify aspects in documentation #111

Merged

Conversation

sadielbartholomew
Copy link
Member

Minor updates to the CATS documentation, including:

  • fix some typos appearing to the user. some misleading e.g. 'cpus' should be 'gpus' in the corresponding CLI argument description;
  • clarify some statements which are somewhat misleading e.g. 'cats looks for a file named config.yaml in the current directory' when strictly it just needs a YAML extension so the same with .yml is also acceptable;
  • update a code snippet implying that 'cats errors out' if no location is provided via CLI or configuration file, when actually at this stage CATS is more clever and will try to estimate location from the IP address.

Hopefully these are fairly self-explanatory suggestions, but please feel free to question.

@sadielbartholomew sadielbartholomew added the documentation Improvements or additions to documentation label Aug 20, 2024
@sadielbartholomew sadielbartholomew self-assigned this Aug 20, 2024
Copy link

codecov bot commented Aug 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.23%. Comparing base (31cfede) to head (715d4cb).
Report is 5 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #111   +/-   ##
=======================================
  Coverage   89.23%   89.23%           
=======================================
  Files          14       14           
  Lines         548      548           
=======================================
  Hits          489      489           
  Misses         59       59           

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

@sadielbartholomew sadielbartholomew requested review from tlestang, abhidg and andreww and removed request for tlestang and abhidg August 21, 2024 09:22
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. One thing I'm unclear about is if the documentation on readthedocs will keep up with our main branch, or keeps versions of the documentation for releases, or what. Not an issue for this PR, but probably needs looking at.

Anyhow, committing this quickly seems sensible.

@sadielbartholomew
Copy link
Member Author

Thanks @andreww, shall I merge, or wait for #110 to go in since we are touching some of the same lines (I am happy to resolve the conflict there)?

@andreww
Copy link
Collaborator

andreww commented Aug 27, 2024

Go ahead and merge - that will tell us for sure what the merge conflicts are for #110. I think they would be easy to fix.

@sadielbartholomew sadielbartholomew merged commit 34c951e into GreenScheduler:main Aug 27, 2024
11 checks passed
@sadielbartholomew sadielbartholomew deleted the minor-updates branch August 27, 2024 11:12
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