Skip to content

Commit 765129a

Browse files
authored
Merge pull request #537 from maxmind/greg/subscore-naming
Update risk factor naming in documentation
2 parents acb6438 + d4d01be commit 765129a

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

src/response/records.ts

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -334,8 +334,8 @@ export interface Disposition {
334334
}
335335

336336
/**
337-
* This object contains subscores for many of the individual components that are
338-
* used to calculate the overall risk score.
337+
* This object contains scores for many of the individual risk factors that
338+
* are used to calculate the overall risk score.
339339
*/
340340
export interface Subscores {
341341
/**
@@ -438,9 +438,9 @@ export interface Subscores {
438438
/**
439439
* Deprecated effective August 29, 2019.
440440
*
441-
* This subscore will default to 1 and will be removed in a future release.
442-
* The user tenure on email is reflected in the [[Subscores.emailAddress]]
443-
* output.
441+
* This risk factor score will default to 1 and will be removed in a future
442+
* release. The user tenure on email is reflected in the
443+
* [[Subscores.emailAddress]] output.
444444
*
445445
* @category Deprecated
446446
* @deprecated
@@ -450,8 +450,9 @@ export interface Subscores {
450450
/**
451451
* Deprecated effective August 29, 2019.
452452
*
453-
* This subscore will default to 1 and will be removed in a future release.
454-
* The IP tenure is reflected in the [[Score.riskScore|overall risk score]].
453+
* This risk factor score will default to 1 and will be removed in a future
454+
* release. The IP tenure is reflected in the
455+
* [[Score.riskScore|overall risk score]].
455456
*
456457
* @category Deprecated
457458
* @deprecated

0 commit comments

Comments
 (0)