Skip to content

Commit

Permalink
docs(firestore): clarify client threadsafety (#9254)
Browse files Browse the repository at this point in the history
* add doc for thread safety

* changes in document as recommended

* change in document description.
  • Loading branch information
HemangChothani authored and crwilcox committed Nov 7, 2019
1 parent c996af0 commit f1136a7
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions firestore/docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
.. include:: README.rst

.. note::

Because the firestore client uses :mod:`grpcio` library, it is safe to
share instances across threads. In multiprocessing scenarios, the best
practice is to create client instances *after* the invocation of
:func:`os.fork` by :class:`multiprocessing.Pool` or
:class:`multiprocessing.Process`.

API Reference
-------------
Expand Down

0 comments on commit f1136a7

Please sign in to comment.