opensearch-project / opensearch-py

Python Client for OpenSearch
https://opensearch.org/docs/latest/clients/python/
Apache License 2.0
359 stars 178 forks source link

samples directory now passes the missing-function-docstring linter #640

Closed macohen closed 11 months ago

macohen commented 11 months ago

Description

The samples directory has docstrings on all functions. This is progress on https://github.com/opensearch-project/opensearch-py/issues/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 https://github.com/opensearch-project/opensearch-py/issues/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.

codecov[bot] commented 11 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (e323ab2) 72.12% compared to head (8752a16) 72.12%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #640 +/- ## ======================================= Coverage 72.12% 72.12% ======================================= Files 89 89 Lines 7939 7939 ======================================= Hits 5726 5726 Misses 2213 2213 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.