diff options
author | Armin Ronacher <armin.ronacher@active-4.com> | 2016-05-19 19:33:58 +0200 |
---|---|---|
committer | Armin Ronacher <armin.ronacher@active-4.com> | 2016-05-19 19:33:58 +0200 |
commit | ce09f6be370e83f0f094af8a66bb8ce3626a7589 (patch) | |
tree | 9fb6996c051bf99c28b639950d330e10ce9dd6b4 | |
parent | ef88cd68d1c10d70ccec728d5925ed27eb675ea4 (diff) | |
download | raven-refactor/breadcrumb-api.tar.gz |
Kill context thread binding docs. It's on api anywaysrefactor/breadcrumb-api
-rw-r--r-- | docs/breadcrumbs.rst | 29 |
1 files changed, 0 insertions, 29 deletions
diff --git a/docs/breadcrumbs.rst b/docs/breadcrumbs.rst index ec304dd..71ab5b1 100644 --- a/docs/breadcrumbs.rst +++ b/docs/breadcrumbs.rst @@ -118,32 +118,3 @@ modifications: breadcrumbs.record(message='This is an important message', category='my_module', level='warning', processor=process_crumb) - -Context Thread Binding ----------------------- - -Typically breadcrumbs work automatically. Both the raven client itself as -well as the framework integrations configure it to work as good as -possible out of the box. In some advanced scenarios however you might not -see breadcrumbs show up. - -This can be because the context needs to be bound to a thread. The -default behavior is to automatically bind the context and to unbind it -when the context is cleared. - -To manually bind the context you can use the `activate()` method on it:: - - client.context.activate() - -To unbind the context you can `deactivate()` it:: - - client.context.deactivate() - -Alternatively you can use the context with the `with` statement:: - - with client.context: - ... - -The context is automatically deactivated if it's cleared unless it's -managed from the main thread. Likewise raven will attempt to auto -activate the client the first time a thread needs it. |