Skip to content

Commit c4c7fe9

Browse files
committed
docs: update retirement driver docs to remove obsolete method examples
1 parent 7112bf5 commit c4c7fe9

1 file changed

Lines changed: 6 additions & 5 deletions

File tree

scripts/user_retirement/docs/driver_setup.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55,14 +55,15 @@ of execution for each environment. Each item is a list in the form of:
5555

5656
#. Start state name
5757
#. End state name
58-
#. IDA to call against (LMS, ECOMMERCE, or CREDENTIALS currently)
58+
#. Service key to call against (for example, LMS or LICENSE_MANAGER)
5959
#. Method name to call in
6060
`edx_api.py <https://github.com/openedx/edx-platform/blob/master/scripts/user_retirement/utils/edx_api.py>`_
6161

62-
For example: ``['RETIRING_CREDENTIALS', 'CREDENTIALS_COMPLETE', 'CREDENTIALS',
63-
'retire_learner']`` will set the user's state to ``RETIRING_CREDENTIALS``, call
64-
a pre-instantiated ``retire_learner`` method in the ``CredentialsApi``, then set
65-
the user's state to ``CREDENTIALS_COMPLETE``.
62+
For example: ``['RETIRING_ENROLLMENTS', 'ENROLLMENTS_COMPLETE', 'LMS',
63+
'retirement_unenroll']`` will set the user's state to
64+
``RETIRING_ENROLLMENTS``, call a pre-instantiated ``retirement_unenroll``
65+
method in the ``LmsApi``, then set the user's state to
66+
``ENROLLMENTS_COMPLETE``.
6667

6768
Examples
6869
********

0 commit comments

Comments
 (0)