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 spell typos and missing whitespace #789

Merged
merged 1 commit into from
Aug 1, 2024
Merged

Conversation

m3et
Copy link
Contributor

@m3et m3et commented Jul 30, 2024

Description

Fix missing whitespaces in IndicesClient docstrings

Issues Resolved

Did not open an issue

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.

@dblock
Copy link
Member

dblock commented Jul 30, 2024

Is this code generated from spec (it should be)? I am afraid the bug is in the generator or the spec.

https://github.com/opensearch-project/opensearch-api-specification

If not, ensuring these descriptions are correct and making sure the API is properly represented in the spec would be grand.

@dblock dblock added the skip-changelog Skips changelog verifier label Jul 30, 2024
@m3et
Copy link
Contributor Author

m3et commented Jul 31, 2024

Is this code generated from spec (it should be)? I am afraid the bug is in the generator or the spec.

https://github.com/opensearch-project/opensearch-api-specification

If not, ensuring these descriptions are correct and making sure the API is properly represented in the spec would be grand.

Can you elaborate on that? Does it mean the the project doc is generated from this project and I should look for the bug there?

I was using the package when I noticed those spelling mistakes, so I'm unaware of the whole project ecosystem and details, any guidelines would be appreciated.

@dblock dblock merged commit 581cbba into opensearch-project:main Aug 1, 2024
51 of 70 checks passed
@dblock
Copy link
Member

dblock commented Aug 1, 2024

@m3et First, I merged this PR, thank you.

I found other instances of the same in another client, https://github.com/search?q=org%3Aopensearch-project%20onlymissing&type=code, if you are interested in fixing those.

Can you elaborate on that? Does it mean the the project doc is generated from this project and I should look for the bug there?

Not yet, but it will be. We will need to merge descriptions between what's here and what's in the spec.

@dblock
Copy link
Member

dblock commented Aug 14, 2024

This was a bug in the generator, the next run undid all these changes.

I fixed it in https://github.com/opensearch-project/opensearch-py/pull/793/files#diff-999765094c323a96b13cc24c24aa13948be15e6beacda7747e83c300420f8018R626.

dblock pushed a commit to dblock/opensearch-py that referenced this pull request Aug 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog Skips changelog verifier
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants