-
Notifications
You must be signed in to change notification settings - Fork 4
README fixes #42
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
Merged
Merged
README fixes #42
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -38,14 +38,14 @@ To install this package simply use pip:: | |
| Support / Feedback | ||
| ================== | ||
|
|
||
| For questions, discussions, or general technical support, visit the MongoDB Community Forums. | ||
| For questions, discussions, or general technical support, visit the `MongoDB Community Forums <https://developer.mongodb.com/community/forums/tag/python>`_. | ||
| The MongoDB Community Forums are a centralized place to connect with other MongoDB users, ask questions, and get answers. | ||
|
|
||
| Bugs / Feature Requests | ||
| ======================= | ||
|
|
||
| Think you’ve found a bug? Want to see a new feature in PyMongoExplain? | ||
| Please open an issue on this GitHub repository. | ||
| Please open an issue on this `GitHub repository <https://github.com/mongodb-labs/pymongoexplain>`_. | ||
|
|
||
| How To Ask For Help | ||
| ------------------- | ||
|
|
@@ -88,6 +88,8 @@ but using this class to run operations runs explain on them, instead of executin | |
|
|
||
| To run explain on a command, first instantiate an ``ExplainCollection`` from the ``Collection`` object originally used to run the command:: | ||
|
|
||
| from pymongoexplain import ExplainCollection | ||
|
|
||
| collection = client.db.products | ||
| explain = ExplainCollection(collection) | ||
|
|
||
|
|
@@ -134,14 +136,23 @@ within the specified script, **in addition to running every command** in the scr | |
| explain output is generated using the `logging <https://docs.python.org/3/library/logging.html>`_ module, | ||
| if your script configures logging module there are certain things to keep in mind: | ||
|
|
||
| - if your script sets the `logging level <https://docs.python.org/3/library/logging.html#logging-levels>`_ | ||
| higher than INFO, the explain output will be suppressed entirely. | ||
| - if your script sets the `logging level <https://docs.python.org/3/library/logging.html#logging-levels>`_ higher than INFO, the explain output will be suppressed entirely. | ||
| - the explain output will be sent to whatever stream your script configures the logging module to send output to. | ||
|
|
||
|
|
||
| Any positional parameters or arguments required by your script can be | ||
| simply be appended to the invocation as follows:: | ||
|
|
||
| python3 -m pymongoexplain <path/to/your/script.py> [PARAMS] [--optname OPTS] | ||
|
|
||
|
|
||
| Limitations | ||
| ----------- | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please leave a blank line after the title.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done. |
||
|
|
||
| This package does not support the fluent `Cursor API <https://pymongo.readthedocs.io/en/stable/api/pymongo/cursor.html>`_, | ||
| so if you attempt to use it like so:: | ||
|
|
||
| ExplainCollection(collection).find({}).sort(...) | ||
|
|
||
| Instead pass all the arguments to the find() call, like so:: | ||
|
|
||
| ExplainCollection(collection).find({}, sort=...) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please add a link to this GitHub repository in the reference to 'this GitHub repository' on L48
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.