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

Feature Request: add examples and references for Mongo query syntax to Docs #702

Open
rkingsbury opened this issue Aug 4, 2022 · 2 comments
Assignees
Labels
docs documentation enhancement

Comments

@rkingsbury
Copy link
Collaborator

The documentation currently makes reference to PyMongo query syntax without providing any links or examples. We should add a tutorial page to the docs describing the basics of pymongo queries, with a link to more advanced tutorials such as this page.

I hereby assign this to myself, unless someone else beats me to it :)

@rkingsbury rkingsbury added enhancement docs documentation labels Jun 8, 2023
@Andrew-S-Rosen
Copy link
Member

Commenting to say that I agree this is an important aspect missing from the docs. I do not hereby assign myself to it, however, at least for the time being. 😉

@rkingsbury
Copy link
Collaborator Author

As a baby step that you can use in the mean time, I've created a tutorial notebook for pyEQL (which uses a maggma Store) which contains instructions for using query, distinct, and count. I will probably draw heavily from this to add something to the maggma docs.

https://pyeql.readthedocs.io/en/latest/examples/pyeql_tutorial_database.html#How-to-Search-the-Database

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs documentation enhancement
Projects
None yet
Development

No branches or pull requests

2 participants