Skip to content

Commit d167928

Browse files
author
Bryan Worrell
committed
Updated docstrings on ExploitTarget
1 parent 7a561c5 commit d167928

1 file changed

Lines changed: 29 additions & 34 deletions

File tree

stix/exploit_target/__init__.py

Lines changed: 29 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -59,18 +59,17 @@ def __init__(self, id_=None, idref=None, timestamp=None, title=None,
5959

6060
@property
6161
def vulnerabilities(self):
62-
"""A list of ``Vulnerability`` objects
62+
"""A collection of :class:`.Vulnerability` objects. This behaves like
63+
a ``MutableSequence`` type.
6364
6465
Default Value: ``None``
6566
6667
Returns:
67-
A list of
68-
:class:`stix.exploit_target.vulnerability`
68+
A list of :class:`.Vulnerability`
6969
7070
Raises:
7171
ValueError: If set to a value that is not ``None`` and not an
72-
instance of
73-
:class:`stix.exploit_target.vulnerability`
72+
instance of :class:`.Vulnerability`
7473
7574
"""
7675

@@ -80,74 +79,69 @@ def vulnerabilities(self):
8079
def vulnerabilities(self, value):
8180
self._vulnerabilities = _Vulnerabilities(value)
8281

83-
def add_vulnerability(self, v):
84-
"""Adds a vulnerability to the ``vulnerabilies`` list property.
82+
def add_vulnerability(self, value):
83+
"""Adds a vulnerability to the :attr:`vulnerabilities` list property.
8584
8685
Note:
8786
If ``None`` is passed in no value is added
8887
8988
Args:
90-
v: A Vulnerability value.
89+
value: A :class:`.Vulnerability` object..
9190
92-
Raises: ValueError if the ``v`` param is of type
93-
:class:`stix.exploit_target.vulnerability`
94-
91+
Raises:
92+
ValueError: if the `value` param is of type :class:`.Vulnerability`
9593
9694
"""
97-
self.vulnerabilities.append(v)
95+
self.vulnerabilities.append(value)
9896

9997
@property
10098
def weaknesses(self):
101-
"""A list of ``Weakness`` objects
99+
"""A collection of :class:`.Weakness` objects. This behaves like
100+
a ``MutableSequence`` type.
102101
103102
Default Value: ``None``
104103
105104
Returns:
106-
A list of
107-
:class:`stix.exploit_target.weakness`
105+
A list of :class:`.Weakness` objects.
108106
109107
Raises:
110108
ValueError: If set to a value that is not ``None`` and not an
111-
instance of
112-
:class:`stix.exploit_target.weakness`
109+
instance of :class:`.Weakness`
113110
114111
"""
115-
116112
return self._weaknesses
117113

118114
@weaknesses.setter
119115
def weaknesses(self, value):
120116
self._weaknesses = _Weaknesses(value)
121117

122-
def add_weakness(self, v):
123-
"""Adds a weakness to the ``weaknesses`` list property.
118+
def add_weakness(self, value):
119+
"""Adds a weakness to the :attr:`weaknesses` list property.
124120
125121
Note:
126122
If ``None`` is passed in no value is added
127123
128124
Args:
129-
v: A weakness value.
125+
value: A :class:`.Weakness` object.
130126
131-
Raises: ValueError if the ``v`` param is of type :class:`stix.exploit_target.weakness`
132-
127+
Raises: ValueError if the `value` param is of type :class:`.Weakness`
133128
134129
"""
135-
self.weaknesses.append(v)
130+
self.weaknesses.append(value)
136131

137132
@property
138133
def configuration(self):
139-
"""A list of ``Configuration`` objects
134+
"""A list of :class:`.Configuration` objects. This behaves like
135+
a ``MutableSequence`` type.
140136
141137
Default Value: ``None``
142138
143139
Returns:
144-
A list of
145-
:class:`stix.exploit_target.configuration`
140+
A list of :class:`.Configuration` objects.
146141
147142
Raises:
148143
ValueError: If set to a value that is not ``None`` and not an
149-
instance of
150-
:class:`stix.exploit_target.configuration`
144+
instance of :class:`.Configuration`.
151145
152146
"""
153147

@@ -157,19 +151,20 @@ def configuration(self):
157151
def configuration(self, value):
158152
self._configuration = _Configurations(value)
159153

160-
def add_configuration(self, v):
161-
"""Adds a configuration to the ``configurations`` list property.
154+
def add_configuration(self, value):
155+
"""Adds a configuration to the :attr:`configurations` list property.
162156
163157
Note:
164158
If ``None`` is passed in no value is added
165159
166160
Args:
167-
v: A configuration value.
161+
value: A configuration value.
168162
169-
Raises: ValueError if the ``v`` param is of type :class:`stix.exploit_target.configuration`
163+
Raises:
164+
ValueError: If the `value` param is of type :class:`.Configuration`
170165
171166
"""
172-
self.configuration.append(v)
167+
self.configuration.append(value)
173168

174169
def to_obj(self, return_obj=None, ns_info=None):
175170
if not return_obj:

0 commit comments

Comments
 (0)