From f12cc82d8afb084e2c5365f7fe012501e18351b1 Mon Sep 17 00:00:00 2001 From: Emmanuelle Vargas-Gonzalez Date: Tue, 11 Dec 2018 13:22:04 -0500 Subject: [PATCH] incorporate feedback update documentation for core.py and automatic copyright year for docs --- docs/conf.py | 3 ++- stix2/core.py | 9 ++++++--- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index ab8681c..2a10fbd 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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__ diff --git a/stix2/core.py b/stix2/core.py index 9165a2a..830d98c 100644 --- a/stix2/core.py +++ b/stix2/core.py @@ -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.