Merge pull request #312 from zowe/doc-string-enforcer

Doc string enforcer and annotations

.github/workflows/sdk-build.yml

@@ -28,6 +28,10 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install -r requirements.txt
+      - name: Lint with pydocstyle
+        run: pydocstyle --match-dir='^(?!build$).*' --match='^(?!(__init__\.py|setup\.py$)).*\.py$' src
+      - name: Lint with pydoclint
+        run: pydoclint --exclude='.*/build/.*' src
       - name: Lint with flake8
         run: |
           # stop the build if there are Python syntax errors or undefined names

.pydocstyle

@@ -0,0 +1,3 @@
+[pydocstyle]
+convention = numpy
+add-ignore = D107, D207

CHANGELOG.md

@@ -2,21 +2,31 @@
 
 All notable changes to the Zowe Client Python SDK will be documented in this file.
 
+## Recent Changes
+
+### Enhancements
+
+- Supported for doc string enforcer [#309] (https://github.com/zowe/zowe-client-python-sdk/issues/309)
+
+- Add type annotations for all methods [#280] (https://github.com/zowe/zowe-client-python-sdk/issues/280)
+
+### Bug Fixes
+
 ## `1.0.0-dev18`
 
 ### Enhancements
 
 - Included support for `AUTH_TYPE_CERT_PEM` and `AUTH_TYPE_NONE` in `session` [#291] (https://github.com/zowe/zowe-client-python-sdk/issues/291) and [#296] (https://github.com/zowe/zowe-client-python-sdk/issues/296)
 
-- Updated all functions descriptions to be consitent [#279] (https://github.com/zowe/zowe-client-python-sdk/issues/279)
+- Updated doc strings for all functions to be consistent [#279] (https://github.com/zowe/zowe-client-python-sdk/issues/279)
 
 - *Breaking*: Added Support for turning off loggers. Replaced `setLoggerLevel` in Logger class with `setAllLoggerLevel` [#278] (https://github.com/zowe/zowe-client-python-sdk/issues/278)
 
 ### Bug Fixes
 
 - Fixed a bug on `create` in `Datasets` where the target dataset gets created with a different block size when `like` is specified [#295] (https://github.com/zowe/zowe-client-python-sdk/issues/295)
 
-- Fixed a bug on `logger` that it would affect all Python application loggers. 
+- Fixed a bug on `logger` that it would affect all Python application loggers. [#314] (https://github.com/zowe/zowe-client-python-sdk/issues/314)
 
 ## `1.0.0-dev17`
 

pyproject.toml

@@ -3,3 +3,9 @@ line-length = 120
 
 [tool.isort]
 profile = "black"
+
+[tool.pydoclint]
+style = "numpy"
+check-arg-order = false
+require-return-section-when-returning-nothing = false
+quiet = true

requirements.txt

@@ -16,6 +16,7 @@ mccabe==0.7.0
 nose2==0.10.0
 pycodestyle==2.9.0
 pydocstyle==5.1.1
+pydoclint==0.5.3
 pyfakefs
 pyflakes==2.5.0
 pylama==7.7.1
@@ -37,3 +38,4 @@ zipp==3.19.1
 -e ./src/zos_jobs
 -e ./src/zos_tso
 -e ./src/zosmf
+