opensearch-project / opensearch-py

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

Fix spell typos and missing whitespace #789

Closed m3et closed 2 months ago

m3et commented 2 months ago

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 commented 2 months ago

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.

m3et commented 2 months ago

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 commented 2 months ago

@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 commented 1 month ago

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.