From 5cca643db10eee125a378c53437fe14e4f42d48d Mon Sep 17 00:00:00 2001 From: Tres Seaver Date: Fri, 3 Jul 2015 22:00:21 -0400 Subject: [PATCH] Fix docstrings FBS Sphinx rendering. --- docs/datastore-api.rst | 37 ------------------------------------- docs/index.rst | 1 - gcloud/datastore/client.py | 4 ++-- 3 files changed, 2 insertions(+), 40 deletions(-) delete mode 100644 docs/datastore-api.rst diff --git a/docs/datastore-api.rst b/docs/datastore-api.rst deleted file mode 100644 index 536aa039ba18..000000000000 --- a/docs/datastore-api.rst +++ /dev/null @@ -1,37 +0,0 @@ -.. toctree:: - :maxdepth: 1 - :hidden: - -Datastore ---------- - -.. include:: _components/datastore-quickstart.rst - -:mod:`gcloud.datastore` -~~~~~~~~~~~~~~~~~~~~~~~ - -.. automodule:: gcloud.datastore - :members: get_connection, get_default_connection, get_default_dataset_id, - set_default_connection, set_default_dataset_id, set_defaults - -Connections -~~~~~~~~~~~ - -.. automodule:: gcloud.datastore.connection - :members: - :undoc-members: - :show-inheritance: - -Interacting with the API -~~~~~~~~~~~~~~~~~~~~~~~~ - -.. automodule:: gcloud.datastore.api - :members: - :undoc-members: - :show-inheritance: - -Helper functions -~~~~~~~~~~~~~~~~ - -.. automodule:: gcloud.datastore.helpers - :members: diff --git a/docs/index.rst b/docs/index.rst index 603da90dcedb..963d2fe1cbce 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,7 +3,6 @@ :hidden: gcloud-api - datastore-api datastore-client datastore-entities datastore-keys diff --git a/gcloud/datastore/client.py b/gcloud/datastore/client.py index b5cb0f142f89..3c2cecf8cfcd 100644 --- a/gcloud/datastore/client.py +++ b/gcloud/datastore/client.py @@ -32,7 +32,7 @@ def _extended_lookup(connection, dataset_id, key_pbs, eventual=False, transaction_id=None): """Repeat lookup until all keys found (unless stop requested). - Helper function for :method:`Client.get_multi`. + Helper function for :meth:`Client.get_multi`. :type connection: :class:`gcloud.datastore.connection.Connection` :param connection: The connection used to connect to datastore. @@ -134,7 +134,7 @@ def get(self, key, missing=None, deferred=None): .. note:: - This is just a thin wrapper over :method:`get_multi`. + This is just a thin wrapper over :meth:`get_multi`. The backend API does not make a distinction between a single key or multiple keys in a lookup request.