Skip to content

Commit 420164a

Browse files
Update docstring verbiage per PR review
Co-authored-by: Matthew Brett <[email protected]>
1 parent 9978b08 commit 420164a

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

nibabel/tmpdirs.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,11 @@ def __exit__(self, exc, value, tb):
5151
class InTemporaryDirectory(TemporaryDirectory):
5252
""" Create, return, and change directory to a temporary directory
5353
54-
NOTE: This implementation is not thread-safe and should be used with
55-
caution by external consumers of this library.
54+
Notes
55+
------
56+
As its name suggests, the class temporarily changes the working
57+
directory of the Python process, and this is not thread-safe. We suggest
58+
using it only for tests.
5659
5760
Examples
5861
--------

0 commit comments

Comments
 (0)