Skip to content

Commit 1449589

Browse files
authored
docs: add note about multiprocessing usage (#26)
1 parent 0134f2e commit 1449589

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

docs/index.rst

+7
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
.. include:: README.rst
22

3+
.. note::
4+
5+
Because this client uses :mod:`grpcio` library, it is safe to
6+
share instances across threads. In multiprocessing scenarios, the best
7+
practice is to create client instances *after* the invocation of
8+
:func:`os.fork` by :class:`multiprocessing.Pool` or
9+
:class:`multiprocessing.Process`.
310

411
Using the API
512
-------------

noxfile.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ def docs(session):
141141
"""Build the docs for this library."""
142142

143143
session.install("-e", ".")
144-
session.install("sphinx", "alabaster", "recommonmark")
144+
session.install("sphinx<3.0.0", "alabaster", "recommonmark")
145145

146146
shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True)
147147
session.run(

0 commit comments

Comments
 (0)