Skip to content

Commit

Permalink
docs: updated status description from feedback
Browse files Browse the repository at this point in the history
MST-969
  • Loading branch information
ashultz0 committed Aug 16, 2021
1 parent a4c3ee6 commit 4295b59
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions edx_name_affirmation/statuses.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,19 @@ class VerifiedNameStatus(str, Enum):
"""
Possible states for the verified name.
Pending: the verified name has been created, but not seen by anyone
Pending: the verified name has been created
Submitted: the verified name has been submitted to a verification authority
Approved, Denied: resulting states from that authority
State transitions in the verifying processes may not move this status.
For example in proctoring the verification might be pending at exam start,
unchanged when the exam is ready to submit, move to submitted on submit,
and then remain unchanged through multiple verification statuses until
the exam is verified or rejected.
This is the status of the verified name attempt, which is related to
but separate from the status of the verifying process such as IDV or proctoring.
Status changes in the verifying processes are usually more fine grained.
For example when proctoring changes from ready to start to started the verified
name is still pending. Once proctoring is actually submitted the verified name
can be considered submitted.
The expected lifecycle is pending -> submitted -> approved/denied.
Expand Down

0 comments on commit 4295b59

Please sign in to comment.