samples directory now passes the missing-function-docstring linter #640
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Mark Cohen <markcoh@amazon.com>
…l continue to work on this before committing setup.cfg Signed-off-by: Mark Cohen <markcoh@amazon.com>
…'t fail while work on docstrings continues Signed-off-by: Mark Cohen <markcoh@amazon.com>
macohen
requested review from
VachaShah,
dblock,
harshavamsi,
axeoman,
Shephalimittal,
saimedhi and
florianvazelle
as code owners
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #640 +/- ##
=======================================
Coverage 72.12% 72.12%
=======================================
Files 89 89
Lines 7939 7939
=======================================
Hits 5726 5726
Misses 2213 2213 ☔ View full report in Codecov by Sentry. |
saimedhi
requested changes
Dec 22, 2023
samples/hello/hello.py
Outdated
| """ | ||
| an example showing how to create an synchronous connection to OpenSearch, create an index, index a document | ||
| and search to return the document | ||
| :return: |
There was a problem hiding this comment.
Hello @macohen,
Thanks for your contribution! I've noticed that :return: appears to be empty at several places. Could you please fill it or remove it if not essential?
There was a problem hiding this comment.
done! thanks for the review. :)
There was a problem hiding this comment.
Linter is failing. Could you please run nox -rs format
There was a problem hiding this comment.
yeah. I saw that after I pushed. fixing log_collection_sample.py
Signed-off-by: Mark Cohen <markcoh@amazon.com>
Signed-off-by: Mark Cohen <markcoh@amazon.com>
saimedhi
approved these changes
Dec 22, 2023
roma2023
pushed a commit
to roma2023/opensearch-py
that referenced
this pull request
Dec 28, 2023
…pensearch-project#640) * updated files with docstrings to pass pylint Signed-off-by: Mark Cohen <markcoh@amazon.com> * updated samples to prepare for enabling missing-docstring linter; will continue to work on this before committing setup.cfg Signed-off-by: Mark Cohen <markcoh@amazon.com> * removed missing-function-docstring from setup.cfg so the linter doesn't fail while work on docstrings continues Signed-off-by: Mark Cohen <markcoh@amazon.com> * corrected unnecessary return docstring values Signed-off-by: Mark Cohen <markcoh@amazon.com> * fixing failure in 'black' on reformatting Signed-off-by: Mark Cohen <markcoh@amazon.com> --------- Signed-off-by: Mark Cohen <markcoh@amazon.com> Signed-off-by: roma2023 <romasaparhan19@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The samples directory has docstrings on all functions. This is progress on #610. The missing-function-docstring linter has not been enabled in setup.cfg because work in other directories is still needed and I wanted to break up the work into smaller commits; merges.
Issues Resolved
N/A - progress on #610
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.