Skip to main content
A VerificationIssue is a single finding from a verification run — for example an unsupported figure or an out-of-date citation. Use the triage methods below to resolve each one: mark it fixed, flag it for review, ignore it, or verify it.

Triage

set_status

VerificationIssue.set_status(status: IssueStatus, comment: Optional[str] = None) -> VerificationIssue
Set this issue’s status, optionally attaching a comment. Parameters
status
IssueStatus
required
comment
Optional[str]
default:"None"
Returns
returns
VerificationIssue

ignore

VerificationIssue.ignore(comment: Optional[str] = None) -> VerificationIssue
Parameters
comment
Optional[str]
default:"None"
Returns
returns
VerificationIssue

flag

VerificationIssue.flag(comment: Optional[str] = None) -> VerificationIssue
Parameters
comment
Optional[str]
default:"None"
Returns
returns
VerificationIssue

mark_fixed

VerificationIssue.mark_fixed(comment: Optional[str] = None) -> VerificationIssue
Parameters
comment
Optional[str]
default:"None"
Returns
returns
VerificationIssue

verify

VerificationIssue.verify(comment: Optional[str] = None) -> VerificationIssue
Parameters
comment
Optional[str]
default:"None"
Returns
returns
VerificationIssue

Types

Configuration objects, response shapes, and enums used by the methods above.

IssueStatus

Where an issue stands after triage: open, ignored, flagged, fixed, or verified. Members
  • OPEN = "STATUS_OPEN"
  • IGNORED = "STATUS_IGNORED"
  • FLAGGED = "STATUS_FLAGGED"
  • FIXED = "STATUS_FIXED"
  • VERIFIED = "STATUS_VERIFIED"

IssueSeverity

How serious an issue is, from an outright error to already verified. Members
  • ERROR = "SEVERITY_ERROR"
  • REVIEW_NEEDED = "SEVERITY_REVIEW_NEEDED"
  • VERIFIED = "SEVERITY_VERIFIED"
  • NOT_FOUND = "SEVERITY_NOT_FOUND"

IssueCategory

What kind of content an issue concerns: a number, text, formatting, or a table. Members
  • NUMBER = "NUMBER"
  • TEXT = "TEXT"
  • FORMAT = "FORMAT"
  • TABLE = "TABLE"