Warn against using workbench with the rest of lib

Doing so may cause issues because the workbench overwrites the STIX
Object mapping.
stix2.0
Chris Lenk 2018-04-04 09:47:48 -04:00
parent 940afb0012
commit a1af05a14e
1 changed files with 14 additions and 1 deletions

View File

@ -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": [
"<div class=\"alert alert-warning\">\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",
"</div>"
]
}
],
"metadata": {