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

merged 29 commits into from Dec 23, 2022

Conversation

anthonyburdi
Copy link
Member

Changes proposed in this pull request:

Definition of Done

anthonyburdi and others added 23 commits December 19, 2022 16:13
@anthonyburdi
Investigatory code
208c2e8
@anthonyburdi
Merge branch 'develop' into f/dx-144/docstring_linter_for_public_api
2e7b3c0
@anthonyburdi
Attempt 2
57e1910
@anthonyburdi
Automatic format
97e304c
@anthonyburdi
Merge branch 'develop' into f/dx-144/docstring_linter_for_public_api
6d6ce73 
# Conflicts:
#	great_expectations/data_context/data_context/abstract_data_context.py
@anthonyburdi
Remove investigatory code
870b410
@anthonyburdi
Add docformatter to pre-commit config
ae22080
@anthonyburdi
Remove docformatter from pre-commit config
4fe74b6
@anthonyburdi
Merge branch 'develop' into f/dx-144/docstring_linter_for_public_api
6d42559
@anthonyburdi
Add pydocstyle to pyproject.toml
367d5a9
@anthonyburdi
First pass parsing docstring errors
0db9231
@anthonyburdi
Remove unnecessary docs_example_parser param from PublicAPIChecker
c623544
@anthonyburdi
Remove unnecessary docs_example_parser param from PublicAPIChecker
0e5294c
@anthonyburdi
Get errors for docstrings only on entities marked with the @public_ap…
094da6f 
…i decorator
@anthonyburdi
Add pydocstyle to requirements
6141f79
@anthonyburdi
Add invoke task
322af9d
@anthonyburdi
Better messaging
2c51435
@anthonyburdi
Merge branch 'develop' into f/dx-144/docstring_linter_for_public_api
b1e613b
@anthonyburdi @Kilo59
Update scripts/check_public_api_docstrings.py
ab6d88f 
Co-authored-by: Gabriel <gabriel59kg@gmail.com>
@anthonyburdi
Merge branch 'develop' into f/dx-144/docstring_linter_for_public_api
5d13fa1
@anthonyburdi
Linting
4937f9e
@anthonyburdi
Linting
7e80c52
@anthonyburdi
Add docstring linter job using invoke docstrings
aeabc46
@anthonyburdi anthonyburdi self-assigned this Dec 23, 2022
@netlify
Copy link

netlify bot commented Dec 23, 2022 •
edited

✅ Deploy Preview for niobium-lead-7998 ready!

Name Link
🔨 Latest commit 70662ca
🔍 Latest deploy log https://app.netlify.com/sites/niobium-lead-7998/deploys/63a5f96f9293fe0008adb4fe
😎 Deploy Preview https://deploy-preview-6641--niobium-lead-7998.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@ghost
Copy link

ghost commented Dec 23, 2022 •
edited by ghost

👇 Click on the image for a new way to code review

  • Make big changes easier — review code in small groups of related files

  • Know where to start — see the whole change at a glance

  • Take a code tour — explore the change with an interactive tour

  • Make comments and review — all fully sync’ed with github

    Try it now!

Review these changes using an interactive CodeSee Map

Legend

CodeSee Map Legend

@anthonyburdi anthonyburdi requested a review from a team December 23, 2022 18:10
Shinnnyshinshin
Shinnnyshinshin approved these changes Dec 23, 2022
View reviewed changes
Copy link
Contributor

@Shinnnyshinshin Shinnnyshinshin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅

@anthonyburdi anthonyburdi enabled auto-merge (squash) December 23, 2022 18:39
@anthonyburdi anthonyburdi merged commit b08d936 into develop Dec 23, 2022
@anthonyburdi anthonyburdi deleted the f/dx-144/docstring_linter_for_public_api_ci branch December 23, 2022 19:50
Shinnnyshinshin pushed a commit that referenced this pull request Dec 26, 2022
Merge branch 'develop' into f/DX-101/spark-id-pk
741d652 
* develop:
  [MAINTENANCE] Enrich `RendererConfiguration` primitive types (#6629)
  Skip postgres tests in spark. (#6643)
  [MAINTENANCE] Batch ID must incorporate batch_spec_passthrough.  Instantiate Validator with DataContext in test modules.  Query metrics/expectations types cleanup. (#6636)
  [FEATURE] Use docstring linter for public api to catch missing parameters (#6642)
  [FEATURE] ID/PK Rendering in DataDocs (#6637)
  [FEATURE]  ZEP - Load/dump new style config from DataContext (#6631)
  [MAINTENANCE] Add docstring linter for public api to CI (#6641)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Shinnnyshinshin Shinnnyshinshin Shinnnyshinshin approved these changes

Assignees

@anthonyburdi anthonyburdi

Labels
core-team dx
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@anthonyburdi @Shinnnyshinshin