documentation-website icon indicating copy to clipboard operation
documentation-website copied to clipboard

Fix wait_for_completion option description and default setting docs

Open epugh opened this issue 1 year ago • 2 comments

Description

The documentation for the wait_for_completion turns out to be wrong, the default value is true. However, more importantly, it's not a great doc... I didn't get what it did at first till a colleague pointed it out and then someone on #general clarified it for me!

I did a quick search for wait_for_completion across docs, and stylisticially it's documented in a few ways. For my fix, I took the descirption used in delete-by-query.md.

I did NOT try to fix the other places where maybe the option description could be improved or standardized....

Issues Resolved

List any issues this PR will resolve, e.g. Closes [...].

Version

2.16

Checklist

  • [x ] By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin. For more information on following Developer Certificate of Origin and signing off your commits, please check here.

epugh avatar Aug 30 '24 17:08 epugh

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

github-actions[bot] avatar Aug 30 '24 17:08 github-actions[bot]

@epugh: Let me know once you've implemented the changes and we'll get this merged.

Naarcha-AWS avatar Sep 17 '24 19:09 Naarcha-AWS