You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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."
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)
The text was updated successfully, but these errors were encountered: