PYTHON-3080 Add section to troubleshooting FAQ per driver with top SEO results #918
Conversation
|
I verified that it renders correctly by doing building the docs locally with sphinx. |
doc/common-issues.rst
Outdated
|
|
||
| When one attempts to connect to a <=3.4 version server, PyMongo will throw the following error: | ||
|
|
||
| .. code-block:: |
There was a problem hiding this comment.
You can remove these .. code-block:: lines in favor of ::. For example:
... following error::
>>> client.admin.command('ping')
doc/common-issues.rst
Outdated
|
|
||
| .. code-block:: | ||
| >>> client.admin.command('ping') |
There was a problem hiding this comment.
For all the code examples, indent the lines only 2 spaces like we do for most other code examples.
There was a problem hiding this comment.
It still looks like these examples are intended one tab instead of 2 spaces.
doc/common-issues.rst
Outdated
|
|
||
| PyMongo will no longer support :meth:`pymongo.cursor.count` in the near future. | ||
| Instead, use :meth:`pymongo.collection.count_documents`. | ||
| Note that this is NOT the same as ``Cursor.count_documents`` (which does not exist), |
There was a problem hiding this comment.
We should show the AttributeError: 'Cursor' object has no attribute 'count_documents' error as well.
doc/common-issues.rst
Outdated
| This is due to the fact that PyMongo discovers replica set members using the response from the isMaster command which | ||
| then contains the address and ports of the other members. However, these addresses and ports will not be accessible through the SSH tunnel. Thus, this behavior is unsupported. | ||
| You can, however, successfully connect to a single MongoDB node using SSH tunneling. |
There was a problem hiding this comment.
"connect directly to a single MongoDB node using with the directConnection=True option with SSH tunneling."
doc/common-issues.rst
Outdated
| Note that this is NOT the same as ``Cursor.count_documents`` (which does not exist), | ||
| this is a method of the Collection class, so you must call it on a collection object:: | ||
|
|
||
| >>> Cursor(MongoClient().db.coll).count() |
There was a problem hiding this comment.
Should this be .count_documents() instead of .count()?
There was a problem hiding this comment.
If I understand correctly, the original Cursor method was called count, and the collection method is called count_documents. So in this case, because I'm illustrating the Cursor method it is just count.
There was a problem hiding this comment.
Ah, I see, so perhaps put the note before and then after say that if you try to use the count property you will see this error:
doc/common-issues.rst
Outdated
| @@ -0,0 +1,98 @@ | |||
| Frequently Encountered Issues | |||
| ============================= | |||
| Also see the `TLS Examples <https://pymongo.readthedocs.io/en/stable/examples/tls.html>`_. | |||
There was a problem hiding this comment.
This should be an RST link to the "Troubleshooting TLS Errors" section. You can add a cross doc link like this:
.. _TLSErrors:
Troubleshooting TLS Errors
..........................
doc/common-issues.rst
Outdated
| ------------------------------------ | ||
|
|
||
| MongoClient has historically accepted CodecOptions's members as keyword arguments, | ||
| however this does not work for type_registry in PyMongo <3.8:: |
There was a problem hiding this comment.
This sentence should be updated now that were only talking about incorrect kwargs in general.
juliusgeo
force-pushed
the
PYTHON-3080
branch
3 times, most recently
from
26653eb to
29378ba
Compare
doc/common-issues.rst
Outdated
|
|
||
| .. code-block:: | ||
| >>> client.admin.command('ping') |
There was a problem hiding this comment.
It still looks like these examples are intended one tab instead of 2 spaces.
| python3 | ||
| migrate-to-pymongo4 | ||
| developer/index | ||
| common-issues |
There was a problem hiding this comment.
This tree is hidden. We need to add a link to the new page in the "Overview" section otherwise it doesn't show up: https://pymongo--918.org.readthedocs.build/en/918/#overview
| :doc:`developer/index` | ||
| Developer guide for contributors to PyMongo. | ||
|
|
||
| :doc:`common-issues` |
There was a problem hiding this comment.
The new rst file still has to be included in the toctree at the bottom of the file.
There was a problem hiding this comment.
I think I have corrected it.
juliusgeo
force-pushed
the
PYTHON-3080
branch
2 times, most recently
from
59b4732 to
f2e96a4
Compare
|
My git configuration for this branch is very messed up--I think I'm just going to blow it all away and restart. |
There was a problem hiding this comment.
Could you fix the following 3 build warnings? (the first 2 are existing issues but we might as well fix it here):
/home/docs/checkouts/readthedocs.org/user_builds/pymongo/checkouts/918/gridfs/grid_file.py:docstring of gridfs.grid_file.GridOut.__iter__:4: WARNING: Block quote ends without a blank line; unexpected unindent.
/home/docs/checkouts/readthedocs.org/user_builds/pymongo/checkouts/918/bson/codec_options.py:docstring of bson.codec_options.CodecOptions:35: WARNING: unknown document: examples/uuid
/home/docs/checkouts/readthedocs.org/user_builds/pymongo/checkouts/918/doc/common-issues.rst:4: WARNING: undefined label: tlserrors (if the link has no caption the label must precede a section header)
|
Huh, we have |
gridfs/grid_file.py
Outdated
|
|
||
| def __iter__(self) -> "GridOut": | ||
| """Return an iterator over all of this file's data. | ||
| r"""Return an iterator over all of this file's data. |
There was a problem hiding this comment.
Please remove the changes to this file. I already fixed this last September in PYTHON-2046. In the future please make sure you branch from the latest commit. For example:
git checkout master
git pull upstream master
git push
git checkout -b PYTHON-XXXX
3 participants
No description provided.