Commit 52a5ef00 by David Ormsbee

Group things so that the RTD theme TOC will be more helpful.

parent 38f5f508
.. _api: .. _api:
Public API
----------
Every Django application in edx-tim has an `api.py` that is its public
interface. If you are using one of these applications from the outside, you
should only import things from that module. The ground rules for api modules
are:
1. All inputs and outputs must be trivially serializable to JSON. This means
`None`, `int`, `float`, `unicode`, `list`, `tuple`, `dict`, and `datetime`.
2. Returned objects should not have methods or business logic attached to them.
3. Caller should assume that these calls can be moderately expensive, as they
may one day move out of process and become network calls. So calling
something a hundred times in a loop should be avoided.
Submissions Submissions
----------- ***********
.. automodule:: submissions.api .. automodule:: submissions.api
:members: :members:
Peer Assessment Peer Assessment
--------------- ***************
.. automodule:: openassessment.peer.api Apps
:members: ----
Submissions
***********
Internals The Submissions app is responsible for:
=========
Submissions 1. Storing and retrieving student submissions for answering a given problem.
----------- 2. Storing and retriveing the raw scores assigned to those submissions.
3. Retrieving the raw scores for all items associated with a particular student
in a particular course.
This application is ignorant of the content of submissions, and assumes them to
simply be opaque unicode strings.
Models
++++++
.. automodule:: submissions.models .. automodule:: submissions.models
:members: :members:
Public Interface Public Interface
---------------- ----------------
Every Django application in edx-tim has an `api.py` that is its public
interface. If you are using one of these applications from the outside, you
should only import things from that module. The ground rules for api modules
are:
1. All inputs and outputs must be trivially serializable to JSON. This means
`None`, `int`, `float`, `unicode`, `list`, `tuple`, `dict`, and `datetime`.
2. Returned objects should not have methods or business logic attached to them.
3. Caller should assume that these calls can be moderately expensive, as they
may one day move out of process and become network calls. So calling
something a hundred times in a loop should be avoided.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment