Skip to content

Commit 89bb0ec

Browse files
committed
Update risk factor naming in documentation
1 parent 34a8fc0 commit 89bb0ec

1 file changed

Lines changed: 10 additions & 9 deletions

File tree

minfraud/models.py

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -812,7 +812,7 @@ def _create_warnings(warnings: List[Dict[str, str]]) -> Tuple[ServiceWarning, ..
812812

813813
@_inflate_to_namedtuple
814814
class Subscores:
815-
"""Subscores used in calculating the overall risk score.
815+
"""Risk factor scores used in calculating the overall risk score.
816816
817817
.. attribute:: avs_result
818818
@@ -912,9 +912,9 @@ class Subscores:
912912
:type: float | None
913913
914914
.. deprecated:: 1.8.0
915-
Deprecated effective August 29, 2019. This subscore will default to 1
916-
and will be removed in a future release. The user tenure on email is
917-
reflected in the email address subscore output.
915+
Deprecated effective August 29, 2019. This risk factor score will
916+
default to 1 and will be removed in a future release. The user
917+
tenure on email is reflected in the email address risk factor score.
918918
919919
.. seealso::
920920
:py:attr:`minfraud.models.Subscores.email_address`
@@ -927,9 +927,9 @@ class Subscores:
927927
:type: float | None
928928
929929
.. deprecated:: 1.8.0
930-
Deprecated effective August 29, 2019. This subscore will default to 1
931-
and will be removed in a future release. The IP tenure is reflected in
932-
the overall risk score.
930+
Deprecated effective August 29, 2019. This risk factor score will
931+
default to 1 and will be removed in a future release. The IP tenure
932+
is reflected in the overall risk score.
933933
934934
.. seealso::
935935
:py:attr:`minfraud.models.Score.risk_score`
@@ -1120,8 +1120,9 @@ class Factors:
11201120
11211121
.. attribute:: subscores
11221122
1123-
A :class:`.Subscores` object containing subscores for many of the
1124-
individual components that are used to calculate the overall risk score.
1123+
A :class:`.Subscores` object containing scores for many of the
1124+
individual risk factors that are used to calculate the overall risk
1125+
score.
11251126
"""
11261127

11271128
billing_address: BillingAddress

0 commit comments

Comments
 (0)