codeflare-sdk icon indicating copy to clipboard operation
codeflare-sdk copied to clipboard

Add more in depth function and arg descriptions to source code

Open KPostOffice opened this issue 1 year ago • 0 comments

Name of Feature or Improvement

Auto generated documentation is built from source code function descriptions, we should include arg and return descriptions there so that anyone using the function should be able to find info there and not have to use the README/manually written docs.

Description of Problem the Feature Should Solve

A clear and concise description of the problem the proposal would address. E.g., "I'm frequently frustrated when X happens." "It's too tedious/confusing to do Y."

Describe the Solution You Would Like to See

https://github.com/project-codeflare/codeflare-sdk/pull/416/files something like this ^ should be included in the ClusterConfig docstrings using one of these styles (https://www.datacamp.com/tutorial/docstrings-python)

KPostOffice avatar Dec 05 '23 16:12 KPostOffice