MISP
/
cti-python-stix2
mirror of https://github.com/MISP/cti-python-stix2
2
0
Fork 0
Code Issues Releases Wiki Activity

incorporate feedback 

update documentation for core.py and automatic copyright year for docs
master
Emmanuelle Vargas-Gonzalez 2018-12-11 13:22:04 -05:00
parent 3f02925fc9
commit f12cc82d8a
2 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/conf.py
View File

@ -1,3 +1,4 @@
import datetime
import os
import re
import sys
@ -32,7 +33,7 @@ source_suffix = '.rst'
master_doc = 'index'
project = 'stix2'
copyright = '2017, OASIS Open'
copyright = '{}, OASIS Open'.format(datetime.date.today().year)
author = 'OASIS Open'
version = __version__

9
stix2/core.py
View File

@ -33,7 +33,8 @@ def parse(data, allow_custom=False, version=None):
into STIX objects, and will be returned as is. Default: False.
version (str): If present, it forces the parser to use the version
provided. Otherwise, the library will make the best effort based
on checking the "spec_version" property.
on checking the "spec_version" property. If none of the above are
possible, it will use the default version specified by the library.
Returns:
An instantiated Python STIX object.
@ -70,7 +71,8 @@ def dict_to_stix2(stix_dict, allow_custom=False, version=None):
Default: False.
version (str): If present, it forces the parser to use the version
provided. Otherwise, the library will make the best effort based
on checking the "spec_version" property.
on checking the "spec_version" property. If none of the above are
possible, it will use the default version specified by the library.
Returns:
An instantiated Python STIX object
@ -132,7 +134,8 @@ def parse_observable(data, _valid_refs=None, allow_custom=False, version=None):
allow_custom (bool): Whether to allow custom properties or not.
Default: False.
version (str): If present, it forces the parser to use the version
provided. Otherwise, the library will use the latest version.
provided. Otherwise, the default version specified by the library
will be used.
Returns:
An instantiated Python STIX Cyber Observable object.