search

zowe / zowe-client-python-sdk

Eclipse Public License 2.0
36 stars 26 forks source link

Update docstrings across all methods to be consistent #279

Open t1m0thyj opened 3 weeks ago

t1m0thyj commented 3 weeks ago

Some methods already have thorough documentation, for example: https://github.com/zowe/zowe-client-python-sdk/blob/5816aab8746e2a137f0b6959d596d6886ecf6ba0/src/zos_files/zowe/zos_files_for_zowe_sdk/files.py#L148-L171

Others have none or very little docs written, so we should update their docs to be consistent.

The docstrings should be formatted so that they render nicely in our auto-generated ReadTheDocs: https://zowe-client-python-sdk.readthedocs.io/en/latest/packages/packages.html

github-actions[bot] commented 3 weeks ago

Thank you for raising this enhancement request. The community has 90 days to vote on it. If the enhancement receives at least 5 upvotes, it is added to our development backlog. If it receives fewer votes, the issue is closed.