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

Investigate tool to enforce doc string style #309

Closed
t1m0thyj opened this issue Jul 10, 2024 · 2 comments
Closed

Investigate tool to enforce doc string style #309

t1m0thyj opened this issue Jul 10, 2024 · 2 comments
Assignees
Labels
enhancement New feature or request priority-medium
Milestone

Comments

@t1m0thyj
Copy link
Member

Is your feature or enhancement request related to a problem or limitation? Please describe

After #279 is addressed, our doc strings are consistent and thorough. But we don't have anything to enforce they remain that way.

Describe your enhancement idea

Investigate a tool that could enforce doc string style across all methods in the Python SDK.
Fix any doc strings that do not conform to the style, and update CI workflows to run the check.

Describe alternatives you've considered

Without a tool to enforce the style, PR reviewers must be vigilant to ensure that new contributors have good doc strings.

Provide any additional context

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

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.

@zFernand0 zFernand0 added this to the v1 LTS milestone Jul 11, 2024
@pem70 pem70 self-assigned this Jul 11, 2024
@zowe-robot zowe-robot moved this from New Issues to Medium Priority in Zowe CLI Squad Jul 12, 2024
@zFernand0
Copy link
Member

Some of the same tools can also help to enforce strong-typing.

Let's kill two birds with one stone 😋

@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

3 participants