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.

Sign up for GitHub

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

Jump to bottom

[MAINTENANCE] Add docstring linter for public api to CI #6641

Merged
merged 29 commits into from Dec 23, 2022
Merged

[MAINTENANCE] Add docstring linter for public api to CI #6641

Show file tree
Hide file tree
Changes from 28 commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
208c2e8
Investigatory code
anthonyburdi Dec 19, 2022
2e7b3c0
Merge branch 'develop' into f/dx-144/docstring_linter_for_public_api
anthonyburdi Dec 19, 2022
57e1910
Attempt 2
anthonyburdi Dec 21, 2022
97e304c
Automatic format
anthonyburdi Dec 21, 2022
6d6ce73
Merge branch 'develop' into f/dx-144/docstring_linter_for_public_api
anthonyburdi Dec 22, 2022
870b410
Remove investigatory code
anthonyburdi Dec 22, 2022
ae22080
Add docformatter to pre-commit config
anthonyburdi Dec 22, 2022
4fe74b6
Remove docformatter from pre-commit config
anthonyburdi Dec 22, 2022
6d42559
Merge branch 'develop' into f/dx-144/docstring_linter_for_public_api
anthonyburdi Dec 22, 2022
367d5a9
Add pydocstyle to pyproject.toml
anthonyburdi Dec 22, 2022
0db9231
First pass parsing docstring errors
anthonyburdi Dec 22, 2022
c623544
Remove unnecessary docs_example_parser param from PublicAPIChecker
anthonyburdi Dec 22, 2022
0e5294c
Remove unnecessary docs_example_parser param from PublicAPIChecker
anthonyburdi Dec 22, 2022
094da6f
Get errors for docstrings only on entities marked with the @public_ap…
anthonyburdi Dec 22, 2022
6141f79
Add pydocstyle to requirements
anthonyburdi Dec 22, 2022
322af9d
Add invoke task
anthonyburdi Dec 22, 2022
2c51435
Better messaging
anthonyburdi Dec 22, 2022
b1e613b
Merge branch 'develop' into f/dx-144/docstring_linter_for_public_api
anthonyburdi Dec 22, 2022
ab6d88f
Update scripts/check_public_api_docstrings.py
anthonyburdi Dec 23, 2022
5d13fa1
Merge branch 'develop' into f/dx-144/docstring_linter_for_public_api
anthonyburdi Dec 23, 2022
4937f9e
Linting
anthonyburdi Dec 23, 2022
7e80c52
Linting
anthonyburdi Dec 23, 2022
aeabc46
Add docstring linter job using `invoke docstrings`
anthonyburdi Dec 23, 2022
4c28599
Test commit with docstring issue
anthonyburdi Dec 23, 2022
ef4f0cf
Fix indentation
anthonyburdi Dec 23, 2022
7108cf5
Install all test dependencies
anthonyburdi Dec 23, 2022
eec4278
Fix intentional test of adding docstring lint error.
anthonyburdi Dec 23, 2022
f41ad2c
Merge branch 'develop' into f/dx-144/docstring_linter_for_public_api_ci
anthonyburdi Dec 23, 2022
70662ca
Merge develop into f/dx-144/docstring_linter_for_public_api_ci
github-actions[bot] Dec 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 7 additions & 0 deletions azure-pipelines-dev.yml
View file
Open in desktop
Expand Up @@ -123,6 +123,13 @@ stages:
- bash: python scripts/check_docstring_coverage.py
name: DocstringChecker

- job: docstring_linter
steps:
- script: |
pip install --requirement reqs/requirements-dev-test.txt
invoke docstrings
name: DocstringLinter

- job: unused_import_checker
steps:
- script: |
Expand Down
8 changes: 8 additions & 0 deletions azure-pipelines.yml
View file
Open in desktop
Expand Up @@ -106,6 +106,14 @@ stages:
- bash: python scripts/check_docstring_coverage.py
name: DocstringChecker

- job: docstring_linter
condition: or(eq(variables.isScheduled, true), eq(variables.isReleasePrep, true), eq(variables.isRelease, true), eq(variables.isManual, true))
steps:
- script: |
pip install --requirement reqs/requirements-dev-test.txt
invoke docstrings
name: DocstringLinter

- job: unused_import_checker
condition: or(eq(variables.isScheduled, true), eq(variables.isReleasePrep, true), eq(variables.isRelease, true), eq(variables.isManual, true))
steps:
Expand Down