ACCESS-NRI / hpcpy

Python client for interacting with HPC scheduling systems.
Other
0 stars 0 forks source link

Update documentation. #7

Closed bschroeter closed 6 days ago

bschroeter commented 1 week ago

The documentation needs additional detail around installation and usage etc.

bschroeter commented 1 week ago

Context is not used here https://github.com/ACCESS-NRI/hpcpy/blob/e25fccac577425edb8d7eb357fa45ed098151340/docs/usage.md?plain=1#L46

bschroeter commented 1 week ago

Might be useful to add spelling CI to the repo?

https://facelessuser.github.io/pyspelling/#usage-in-ci

bschroeter commented 6 days ago

https://www.javierbrea.com/blog/spellcheck-github-action/

bschroeter commented 6 days ago

Spellcheck action now on branch.