Skip to content

Note that context managers are not thread-safe #84

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 13, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docsite/source/module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -535,6 +535,17 @@ This section describes all of the `context managers
<https://docs.python.org/2/reference/datamodel.html#context-managers>`_
provided by the bitmath class.

.. warning::

It is a known limitation that the bitmath context managers are
**not thread-safe**. You may get unexpected results or errors using
these in a threaded environment.

The suggested workaround is to apply formatting to each object
instance directly. See the instance :ref:`format
<instances_format>` method docs for additional reference.


.. note::

For a bit of background, a *context manager* (specifically, the
Expand Down