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

Update docstrings across all methods to be consistent #279

Closed
t1m0thyj opened this issue Jun 6, 2024 · 1 comment
Closed

Update docstrings across all methods to be consistent #279

t1m0thyj opened this issue Jun 6, 2024 · 1 comment
Assignees
Labels
enhancement New feature or request priority-medium
Milestone

Comments

@t1m0thyj
Copy link
Member

t1m0thyj commented Jun 6, 2024

Some methods already have thorough documentation, for example:

def copy_uss_to_dataset(
self, from_filename, to_dataset_name, to_member_name=None, type=FileType.TEXT, replace=False
):
"""
Copy a USS file to dataset.
Parameters
----------
from_filename: str
Name of the file to copy from.
to_dataset_name: str
Name of the dataset to copy to.
to_member_name: str
Name of the member to copy to.
type: FileType, optional
Type of the file to copy from. Default is FileType.TEXT.
replace: bool, optional
If true, members in the target dataset are replaced.
Returns
-------
json
A JSON containing the result of the operation.
"""

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

@t1m0thyj t1m0thyj added the enhancement New feature or request label Jun 6, 2024
@github-project-automation github-project-automation bot moved this to New Issues in Zowe CLI Squad Jun 6, 2024
Copy link

github-actions bot commented Jun 6, 2024

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.

@zowe-robot zowe-robot moved this from New Issues to Medium Priority in Zowe CLI Squad Jun 10, 2024
@zFernand0 zFernand0 added this to the v1 LTS milestone Jun 11, 2024
@pem70 pem70 self-assigned this Jul 8, 2024
@pem70 pem70 mentioned this issue Jul 8, 2024
4 tasks
@github-project-automation github-project-automation bot moved this from Medium Priority to Closed in Zowe CLI Squad Jul 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request priority-medium
Projects
Status: Closed
Development

No branches or pull requests

4 participants