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

Add more in depth function and arg descriptions to source code #422

Open
KPostOffice opened this issue Dec 5, 2023 · 0 comments
Open

Add more in depth function and arg descriptions to source code #422

KPostOffice opened this issue Dec 5, 2023 · 0 comments

Comments

@KPostOffice
Copy link
Collaborator

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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

No branches or pull requests

1 participant