From 52be01a5775d3af2bfda669a5132938d4aab4403 Mon Sep 17 00:00:00 2001 From: Kyle McCormick Date: Mon, 9 Sep 2019 13:12:31 -0400 Subject: [PATCH] Document temporary program_enrollments API to edx-enterprise (#21605) See https://github.com/edx/edx-platform/pull/21511#pullrequestreview-285556560 for more context. --- lms/djangoapps/program_enrollments/api/api.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/lms/djangoapps/program_enrollments/api/api.py b/lms/djangoapps/program_enrollments/api/api.py index b05c2ca275..438dfab2a0 100644 --- 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