From a1af05a14eb4e5863afb43cd6aef65bf6a7ae9b1 Mon Sep 17 00:00:00 2001 From: Chris Lenk Date: Wed, 4 Apr 2018 09:47:48 -0400 Subject: [PATCH] Warn against using workbench with the rest of lib Doing so may cause issues because the workbench overwrites the STIX Object mapping. --- docs/guide/workbench.ipynb | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/docs/guide/workbench.ipynb b/docs/guide/workbench.ipynb index bc7942a..9cb099a 100644 --- a/docs/guide/workbench.ipynb +++ b/docs/guide/workbench.ipynb @@ -53,7 +53,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "## Using A Workbench" + "## Using The Workbench" ] }, { @@ -446,6 +446,19 @@ "source": [ "Defaults can also be set for the [created timestamp](../api/datastore/stix2.workbench.rst#stix2.workbench.set_default_created), [external references](../api/datastore/stix2.workbench.rst#stix2.workbench.set_default_external_refs) and [object marking references](../api/datastore/stix2.workbench.rst#stix2.workbench.set_default_object_marking_refs)." ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "
\n", + "\n", + "**Warning:**\n", + "\n", + "The workbench layer replaces STIX Object classes with special versions of them that use \"wrappers\" to provide extra functionality. Because of this, we recommend that you **either use the workbench layer or the rest of the library, but not both**. In other words, don't import from both ``stix2.workbench`` and any other submodules of ``stix2``.\n", + "\n", + "
" + ] } ], "metadata": {