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

* updated files with docstrings to pass pylint Signed-off-by: Mark Cohen <[email protected]> * updated samples to prepare for enabling missing-docstring linter; will continue to work on this before committing setup.cfg Signed-off-by: Mark Cohen <[email protected]> * removed missing-function-docstring from setup.cfg so the linter doesn't fail while work on docstrings continues Signed-off-by: Mark Cohen <[email protected]> * corrected unnecessary return docstring values Signed-off-by: Mark Cohen <[email protected]> * fixing failure in 'black' on reformatting Signed-off-by: Mark Cohen <[email protected]> --------- Signed-off-by: Mark Cohen <[email protected]>
2023-12-22 12:32:48 -08:00
parent e323ab2435
commit 7b0b58d12b
22 changed files with 119 additions and 17 deletions
@@ -18,6 +18,10 @@ from opensearchpy import OpenSearch


 def main() -> None:
+    """
+    demonstrates various functions to operate on the index (e.g. clear different levels of cache, refreshing the
+    index)
+    """
    # Set up
    client = OpenSearch(
        hosts=["https://localhost:9200"],