minor tweaks to docstrings

pull/1/head
Emmanuelle Vargas-Gonzalez 2021-03-18 10:14:36 -04:00
parent 2ea9c0c63c
commit 922de111ed
2 changed files with 3 additions and 3 deletions

View File

@ -263,7 +263,7 @@ class _STIXBase(Mapping):
def fp_serialize(self, *args, **kwargs):
"""
Serialize a STIX object to a file-like supporting object.
Serialize a STIX object to ``fp`` (a text stream file-like supporting object).
Examples:
>>> import stix2

View File

@ -87,11 +87,11 @@ def serialize(obj, pretty=False, include_optional_defaults=False, **kwargs):
def fp_serialize(obj, fp, pretty=False, include_optional_defaults=False, **kwargs):
"""
Serialize a STIX object as a stream to file-like supporting object.
Serialize a STIX object to ``fp`` (a text stream file-like supporting object).
Args:
obj: The STIX object to be serialized.
fp: A ``.write()``-supporting file-like object.
fp: A text stream file-like object supporting ``.write()``.
pretty (bool): If True, output properties following the STIX specs
formatting. This includes indentation. Refer to notes for more
details. (Default: ``False``)