Skip to content

Commit 3994ece

Browse files
author
Chaim-Leib Halbert
committed
added docstring info about errors raised for About, Result, Score
1 parent 80e31e1 commit 3994ece

File tree

3 files changed

+11
-8
lines changed

3 files changed

+11
-8
lines changed

tincan/about.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,8 @@ def version(self):
4545
makes a 1-element list containing the string.
4646
:setter type: list | tuple | str | unicode | None
4747
:rtype: list
48-
48+
:raises ValueError if invalid version string provided
49+
:raises TypeError if unsupported type is provided
4950
"""
5051
return self._version
5152

tincan/result.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,8 @@ def duration(self):
142142
143143
:setter type: :class:`datetime.timedelta` | unicode | str | int | float | dict | None
144144
:rtype: :class:`datetime.timedelta` | None
145+
:raises ValueError if the provided data was a valid type, but could not be converted
146+
:raises TypeError if unsupported type is provided
145147
"""
146148
return self._duration
147149

@@ -189,7 +191,7 @@ def response(self, value):
189191
e_type = ValueError if isinstance(value, (list, tuple)) else TypeError
190192
msg = (
191193
"Property 'response' in a 'tincan.%s' object must be set with a "
192-
"bytestring, string, unicode, list of ints 0-255, or None.\n\n" %
194+
"string, unicode or None.\n\n" %
193195
self.__class__.__name__,
194196
)
195197
msg += e.message
@@ -208,7 +210,7 @@ def extensions(self):
208210
this signifies the absence of this data.
209211
:setter type: :class:`tincan.extensions.Extensions` | dict | None
210212
:rtype: :class:`tincan.extensions.Extensions` | None
211-
213+
:raises TypeError if unsupported type is provided
212214
"""
213215
return self._extensions
214216

@@ -228,7 +230,7 @@ def extensions(self, value):
228230
repr(value)
229231
))
230232
msg += e.message
231-
e_type = TypeError if not isinstance(value, dict) else ValueError
233+
e_type = ValueError if isinstance(value, dict) else TypeError
232234
raise e_type(msg)
233235

234236
@extensions.deleter

tincan/score.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ def scaled(self):
4848
this signifies the absence of this data.
4949
:setter type: float | int | None
5050
:rtype: float | None
51-
51+
:raises TypeError if unsupported type is provided
5252
"""
5353
return self._scaled
5454

@@ -81,7 +81,7 @@ def raw(self):
8181
this signifies the absence of this data.
8282
:setter type: float | int | None
8383
:rtype: float | None
84-
84+
:raises TypeError if unsupported type is provided
8585
"""
8686
return self._raw
8787

@@ -114,7 +114,7 @@ def min(self):
114114
this signifies the absence of this data.
115115
:setter type: float | int | None
116116
:rtype: float | None
117-
117+
:raises TypeError if unsupported type is provided
118118
"""
119119
return self._min
120120

@@ -146,7 +146,7 @@ def max(self):
146146
this signifies the absence of this data.
147147
:setter type: float | int | None
148148
:rtype: float | None
149-
149+
:raises TypeError if unsupported type is provided
150150
"""
151151
return self._max
152152

0 commit comments

Comments
 (0)