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

Doc string enforcer and annotations #312

Merged
merged 48 commits into from
Jul 23, 2024
Merged
Changes from 1 commit
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
c68e2cc
Update doc string
pem70 Jul 12, 2024
d874fef
Update doc string and annotations for files module
pem70 Jul 13, 2024
05a2c57
Update work flow and doc string
pem70 Jul 15, 2024
32f2bfe
Merge branch 'turning-logger-off' into doc-string-enforcer
pem70 Jul 15, 2024
cbe273a
Update CHANGELOG.md
pem70 Jul 15, 2024
ea1d0b6
Update setup and doc string
pem70 Jul 15, 2024
ec578e4
Update pyproject.toml
pem70 Jul 15, 2024
5387d07
Update workflow
pem70 Jul 15, 2024
48c36ab
Update datasets.py
pem70 Jul 15, 2024
545d977
Update files.py
pem70 Jul 15, 2024
de7d963
Update files.py
pem70 Jul 15, 2024
c3db134
Update files.py
pem70 Jul 15, 2024
184cca5
Update sdk-build.yml
pem70 Jul 15, 2024
b5fa04e
Update workflow
pem70 Jul 15, 2024
ff21ab0
Update pyproject.toml
pem70 Jul 15, 2024
b19e4d7
Update config
pem70 Jul 15, 2024
a628408
Update requirements.txt
pem70 Jul 15, 2024
cf940d5
Update config
pem70 Jul 15, 2024
6b1453f
Update requirements.txt
pem70 Jul 15, 2024
f79af4a
Update requirements.txt
pem70 Jul 15, 2024
fe4548f
Update sdk_api.py
pem70 Jul 15, 2024
c1c8833
Update request_handler.py
pem70 Jul 15, 2024
46ea1fa
Update request_handler.py
pem70 Jul 15, 2024
5aac8fb
Update datasets.py
pem70 Jul 15, 2024
18ea511
Update src/core/zowe/core_for_zowe_sdk/profile_manager.py
pem70 Jul 16, 2024
f299361
Update src/core/zowe/core_for_zowe_sdk/session.py
pem70 Jul 16, 2024
28c3062
Update src/zos_files/zowe/zos_files_for_zowe_sdk/uss.py
pem70 Jul 16, 2024
99e8bcf
Resolve Trae's comments
pem70 Jul 16, 2024
ccd0554
Update src/zos_files/zowe/zos_files_for_zowe_sdk/datasets.py
pem70 Jul 18, 2024
7688eb4
Update src/zos_files/zowe/zos_files_for_zowe_sdk/uss.py
pem70 Jul 18, 2024
843ebdc
Update src/zos_files/zowe/zos_files_for_zowe_sdk/uss.py
pem70 Jul 18, 2024
ab2e208
Update CHANGELOG.md
pem70 Jul 18, 2024
e694c29
Update src/zos_files/zowe/zos_files_for_zowe_sdk/datasets.py
pem70 Jul 18, 2024
63e238f
Update src/zos_files/zowe/zos_files_for_zowe_sdk/datasets.py
pem70 Jul 18, 2024
f0d350d
Update src/zos_files/zowe/zos_files_for_zowe_sdk/file_system.py
pem70 Jul 18, 2024
cc28c79
Update src/zos_files/zowe/zos_files_for_zowe_sdk/uss.py
pem70 Jul 18, 2024
75d12d0
Update src/zos_files/zowe/zos_files_for_zowe_sdk/datasets.py
pem70 Jul 18, 2024
08c3312
Update src/zos_files/zowe/zos_files_for_zowe_sdk/file_system.py
pem70 Jul 18, 2024
e20dd68
Update src/zos_files/zowe/zos_files_for_zowe_sdk/file_system.py
pem70 Jul 18, 2024
539925d
Update src/zos_files/zowe/zos_files_for_zowe_sdk/file_system.py
pem70 Jul 18, 2024
3045504
Update datasets.py
pem70 Jul 18, 2024
1290c78
Merge branch 'main' into doc-string-enforcer
pem70 Jul 18, 2024
8d030a2
Merge branch 'main' into doc-string-enforcer
pem70 Jul 19, 2024
d01f085
Update CHANGELOG.md
pem70 Jul 19, 2024
a8e6d95
Update CHANGELOG.md
pem70 Jul 19, 2024
1cca450
Update logger.py
pem70 Jul 19, 2024
a04dde5
Update logger.py
pem70 Jul 19, 2024
711ecd8
Update datasets.py
pem70 Jul 22, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update workflow
Signed-off-by: pem70 <pem70@pitt.edu>
pem70 committed Jul 15, 2024
commit b5fa04e5961e1e05116798dfcf6ddf55186769b0
2 changes: 1 addition & 1 deletion .github/workflows/sdk-build.yml
Original file line number Diff line number Diff line change
@@ -29,7 +29,7 @@ jobs:
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$' --add-ignore=D107,D402 src
run: pydocstyle --match-dir='^(?!build$).*' --match='^(?!(__init__\.py|setup\.py$)).*\.py$' --config='pyproject.toml' src
- name: Lint with pydoclint
run: pydoclint --exclude='.*/build/.*' src
- name: Lint with flake8
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@ profile = "black"

[tool.pydocstyle]
convention = "numpy"
add-ignore = 'D107'
add-ignore = ['D102', 'D402']

[tool.pydoclint]
style = 'numpy'