Update docs and comments

This commit is contained in:
vrde 2017-11-13 00:17:07 +01:00
parent db7727a459
commit 2192003a5e
No known key found for this signature in database
GPG Key ID: 6581C7C39B3D397D
2 changed files with 5 additions and 5 deletions

View File

@ -1,16 +1,15 @@
"""MongoDB backend implementation.
Contains a MongoDB-specific implementation of the
:mod:`~bigchaindb.backend.changefeed`, :mod:`~bigchaindb.backend.query`, and
:mod:`~bigchaindb.backend.schema` interfaces.
:mod:`~bigchaindb.backend.schema` interface.
You can specify BigchainDB to use MongoDB as its database backend by either
setting ``database.backend`` to ``'rethinkdb'`` in your configuration file, or
setting ``database.backend`` to ``'localmongodb'`` in your configuration file, or
setting the ``BIGCHAINDB_DATABASE_BACKEND`` environment variable to
``'rethinkdb'``.
``'localmongodb'``.
If configured to use MongoDB, BigchainDB will automatically return instances
of :class:`~bigchaindb.backend.rethinkdb.MongoDBConnection` for
of :class:`~bigchaindb.backend.localmongodb.LocalMongoDBConnection` for
:func:`~bigchaindb.backend.connection.connect` and dispatch calls of the
generic backend interfaces to the implementations in this module.
"""

View File

@ -30,6 +30,7 @@ class BigchainDB(Bigchain):
requests.post(ENDPOINT, json=payload)
def write_transaction(self, transaction):
# This method offers backward compatibility with the Web API.
"""Submit a valid transaction to the mempool."""
self.post_transaction(transaction)