-
Notifications
You must be signed in to change notification settings - Fork 32
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
Add content to README; documentation fixups #969
Conversation
@Andrew-S-Rosen any suggested revision are welcome! @munrojm does it make sense to add a paragraph about what the API piece of Looking at the docs, I realize that there is currently nothing in there about the API components at all; that's probably something we should add at some point (separate issue though) |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #969 +/- ##
=======================================
Coverage 88.76% 88.77%
=======================================
Files 46 46
Lines 3979 3981 +2
=======================================
+ Hits 3532 3534 +2
Misses 447 447 ☔ View full report in Codecov by Sentry. |
Looks great! Did we want to add a minimal example so people visually know what we are talking about? Something like my_data = {"a": 1, "b": 2}
store = MongoStore( database="my_db_name", collection_name="my_collection_name", username="my_username", password="my_password", host="my_hostname", port=27017, )
with store:
store.update(my_data) |
Looks good to me! |
That example is hilarious! |
Now that I realize we don't have any documentation of the API components, I'm going to remove the placeholder from the README and merge this. I've opened #972 as a placeholder to remind us that this documentation should be added at some point. |
There is an open_data test failure that snuck in on the last dependency upgrade, which I can't reproduce locally. I'm merging this b/c it's unrelated and will see if re-triggering the auto dependency upgrade can resolve. |
Summary
Makes
README
more descriptive of `maggma''s purpose and function. Closes #886See a preview of the README on my fork here:
https://github.com/rkingsbury/maggma/tree/readme