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.

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

fix examples.asciidoc to match implementation #2252

Merged
merged 4 commits into from Nov 30, 2023

Conversation

mattiassluis
Copy link
Contributor

Documentation mentions wrong / outdated keyword arguments when compared to the code implementation. These fixes correct the documentation to match the implementation.

Closes #2251

@elasticmachine
Copy link
Collaborator

Since this is a community submitted pull request, a Jenkins build has not been kicked off automatically. Can an Elastic organization member please verify the contents of this patch and then kick off a build manually?

@cla-checker-service
Copy link

cla-checker-service bot commented Jul 7, 2023

💚 CLA has been signed

@mattiassluis
Copy link
Contributor Author

❌ Author of the following commits did not sign a Contributor Agreement: 43ce85e

Please, read and sign the above mentioned agreement if you want to contribute to this project

Signed

@mattiassluis
Copy link
Contributor Author

It looks like the linter failed on unrelated code, what is the suggestion to proceed here?

Documentation mentions wrong / outdated keyword arguments when compared to the code implementation. These fixes correct the documentation to match the implementation.

Closes elastic#2251
@pquentin
Copy link
Member

buildkite test this please

Copy link
Member

@pquentin pquentin left a comment

Choose a reason for hiding this comment

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

Thank you! This looks good to me. And sorry for the delay, we had no dedicated maintainer for some months, and this fell through the cracks.

@pquentin
Copy link
Member

buildkite test this please

@pquentin pquentin merged commit ff2ef4d into elastic:main Nov 30, 2023
11 checks passed
github-actions bot pushed a commit that referenced this pull request Nov 30, 2023
* fix examples.asciidoc to match implementation

Documentation mentions wrong / outdated keyword arguments when compared to the code implementation. These fixes correct the documentation to match the implementation.

Closes #2251

* Fix interensting typo

---------

Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co>
(cherry picked from commit ff2ef4d)
pquentin pushed a commit that referenced this pull request Dec 1, 2023
* fix examples.asciidoc to match implementation

Documentation mentions wrong / outdated keyword arguments when compared to the code implementation. These fixes correct the documentation to match the implementation.

Closes #2251

* Fix interensting typo

---------

Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co>
(cherry picked from commit ff2ef4d)

Co-authored-by: Mattias <mattias.sluis@kpn.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Inconsistent keyword argument usage in example documentation vs implementation
3 participants