Skip to content

Commit 690c1dc

Browse files
committed
Code review feedback
1 parent f0b50c0 commit 690c1dc

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

docs/installation.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -91,17 +91,18 @@ details at `PYTHON-1351 <https://datastax-oss.atlassian.net/browse/PYTHON-1351>`
9191

9292
Speeding Up Installation
9393
^^^^^^^^^^^^^^^^^^^^^^^^
94-
9594
By default, installing the driver through ``pip`` uses a pre-compiled, platform-specific wheel when available.
9695
If using a source distribution rather than a wheel, Cython is used to compile certain parts of the driver.
9796
This makes those hot paths faster at runtime, but the Cython compilation
9897
process can take a long time -- as long as 10 minutes in some environments.
9998

10099
In environments where performance is less important, it may be worth it to
101100
:ref:`disable Cython as documented below <cython-extensions>`.
102-
You can also use ``build-concurrency`` key in the ``tool.cassandra-driver`` table of pyproject.toml to
103-
increase the number of threads used to build the driver and any C extensions.
104101

102+
Cython also supports concurrent builds of native extensions. The ``build-concurrency`` key in the
103+
``tool.cassandra-driver`` table of pyproject.toml is an integer value which specifies the number of
104+
concurrent builds Cython may execute. The value for this key must be a non-negative integer; the default is zero,
105+
indicating no concurrent builds. The ``multiprocessing`` module must be installed if concurrent builds are used.
105106

106107
OSX Installation Error
107108
^^^^^^^^^^^^^^^^^^^^^^
@@ -143,7 +144,6 @@ Once the dependencies are installed, simply run::
143144

144145
python setup.py install
145146

146-
147147
(*Optional*) Non-python Dependencies
148148
------------------------------------
149149
The driver has several **optional** features that have non-Python dependencies.
@@ -156,7 +156,7 @@ for token-aware routing with the ``Murmur3Partitioner``,
156156
and Cython optimized extensions.
157157

158158
When installing manually these options can be disabled by changing the corresponding
159-
key in the ``tool.cassandra-driver`` table of pyproject.toml to "false". Please consult
159+
key in the ``tool.cassandra-driver`` table of pyproject.toml to ``false``. Please consult
160160
the ``build-murmur3-extension``, ``build-libev-extension`` and ``build-cython-extensions``
161161
keys (respectively) to disable these extensions.
162162

@@ -184,7 +184,7 @@ pure Python implementation.
184184

185185
This process does take some time, however, so if you wish to build without generating these extensions using
186186
Cython you can do so by changing the ``build-cython-extensions`` key in the ``tool.cassandra-driver`` table of pyproject.toml.
187-
By default this key is set to "true"; simply changing it to "false" will disable all Cython functionality.
187+
By default this key is set to ``true``; simply changing it to ``false`` will disable all Cython functionality.
188188

189189
Supported Event Loops
190190
^^^^^^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)