From 922de111ed965bb0f1b24c78d77a4e9dccacc7d8 Mon Sep 17 00:00:00 2001 From: Emmanuelle Vargas-Gonzalez Date: Thu, 18 Mar 2021 10:14:36 -0400 Subject: [PATCH] minor tweaks to docstrings --- stix2/base.py | 2 +- stix2/serialization.py | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/stix2/base.py b/stix2/base.py index 03d8ea4..2c48ef6 100644 --- a/stix2/base.py +++ b/stix2/base.py @@ -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 diff --git a/stix2/serialization.py b/stix2/serialization.py index 8822f33..660bba6 100644 --- a/stix2/serialization.py +++ b/stix2/serialization.py @@ -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``)