summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorIonel Cristian Mărieș <contact@ionelmc.ro>2017-03-09 00:02:20 +0200
committerGitHub <noreply@github.com>2017-03-09 00:02:20 +0200
commit2d6bc48c613c8adb9b3d492d6a0fe8175290a457 (patch)
tree1dae6d0717f2c91cc4eb4040d12f7f0ab5f07c9b /README.rst
parentf6792164f414f5be0e117878d5bacff06c0d4ddb (diff)
More explaining. Ref #13.
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst7
1 files changed, 5 insertions, 2 deletions
diff --git a/README.rst b/README.rst
index 39f4184..a0f5d6b 100644
--- a/README.rst
+++ b/README.rst
@@ -88,9 +88,12 @@ It allows you to:
* `Pickle <https://docs.python.org/3/library/pickle.html>`_ tracebacks and raise exceptions
with pickled tracebacks in different processes. This allows better error handling when running
code over multiple processes (imagine multiprocessing, billiard, futures, celery etc).
-* Parse traceback strings and raise with the parsed tracebacks. *No pickling is used*.
+* Create traceback objects from strings (the ``from_string`` method). *No pickling is used*.
+* Serialize tracebacks to/from plain dicts (the ``from_dict`` and ``to_dict`` methods). *No pickling is used*.
+* Raise the tracebacks created from the aforementioned sources.
-Again, note that using the pickle support is completely optional.
+**Again, note that using the pickle support is completely optional. You are solely responsible for
+security problems should you decide to use the pickle support.**
Installation
============