Skip to content
This repository has been archived by the owner on Jan 18, 2024. It is now read-only.

[BUG] Documentation doesn't explain what this project is #37

Closed
dblock opened this issue Dec 31, 2021 · 3 comments
Closed

[BUG] Documentation doesn't explain what this project is #37

dblock opened this issue Dec 31, 2021 · 3 comments
Assignees
Labels
bug Something isn't working

Comments

@dblock
Copy link
Member

dblock commented Dec 31, 2021

What is the bug?
The fork didn't carry a README that explains what this project is, why it exists or how to use it.

Do you have any additional context?
I came from opensearch-project/opensearch-py#90, and it took me a while to figure out what the difference between opensearch-py and opensearch-dsl-py is.

@dblock dblock added the bug Something isn't working label Dec 31, 2021
@elfisher
Copy link

elfisher commented Jan 4, 2022

@VijayanB what are your thoughts on adding a sentence to the readme that outlines what this dsl client is used for. Something like "opensearch-dsl-py is a python client specifically used for build and running queries against OpenSearch."

@VijayanB
Copy link
Member

VijayanB commented Jan 4, 2022

@elfisher Agree. I will create a PR to update the same.

@VijayanB VijayanB self-assigned this Jan 4, 2022
@wbeckler
Copy link

wbeckler commented Aug 7, 2022

@VijayanB Did you create the PR for changing the README?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

5 participants