Document temporary program_enrollments API to edx-enterprise (#21605)

See https://github.com/edx/edx-platform/pull/21511#pullrequestreview-285556560 for more context.
2019-09-09 13:12:31 -04:00
parent dbc36a3241
commit 52be01a577
1 changed files with 5 additions and 1 deletions
--- a/lms/djangoapps/program_enrollments/api/api.py
+++ b/lms/djangoapps/program_enrollments/api/api.py
@@ -1,6 +1,10 @@
 # -*- coding: utf-8 -*-
 """
-ProgramEnrollment internal api.
+ProgramEnrollment internal API intended for Enterprise API.
+
+The Enterprise API currently depends on this module being present with these
+functions, as implemented in ./utils.py. This module will be refactored
+away in https://openedx.atlassian.net/browse/ENT-2294
 """
 from __future__ import absolute_import, unicode_literals