ylqjgm
/
canvas-lms
mirror of https://github.com/instructure/canvas-lms.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update API text for Outcomes Import Format Documentation 

Updated documentation to say calculation method and mastery scale
do not need to be defined in the imported .csv.

closes OUT-5134

flag=none

Test plan:
- See changes in the documentation.

Change-Id: Idfb2f338e1ab1aa4bef79588110f0c94a54acc27
Reviewed-on: https://gerrit.instructure.com/c/canvas-lms/+/321269
Tested-by: Service Cloud Jenkins <svc.cloudjenkins@instructure.com>
Reviewed-by: Chrystal Langston <chrystal.langston@instructure.com>
QA-Review: Chrystal Langston <chrystal.langston@instructure.com>
Product-Review: Kyle Rosenbaum <krosenbaum@instructure.com>
This commit is contained in:
Nayeel Imtiaz 2023-06-26 10:30:01 -07:00 committed by Kyle Rosenbaum
parent d4ff2cfe8e
commit 6d12d6166d
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/api/outcomes_csv.md
View File

@ -96,7 +96,7 @@ This value does not apply to learning outcome groups.</td>
<td></td>
<td>Must be one of "decaying_average", "n_mastery", "highest", "latest", "average" or blank.
This field must be blank for learning outcome groups. If not provided and this
is a learning outcome, then the calculation method defaults to "decaying_average".</td>
is a learning outcome, then the calculation method defaults to "decaying_average". If the Account and Course Level Outcome Mastery Scales flag is enabled, the calculation_method field does not need to be defined in the imported .csv. The calculation_method field will be determined by the account and course settings.</td>
</tr>
<tr>
<td>calculation_int</td>
@ -104,7 +104,7 @@ is a learning outcome, then the calculation method defaults to "decaying_average
<td></td>
<td>Valid values depend on the "calculation_method". For "decaying_average", the value must
be between 1 and 99, inclusive. For "n_mastery", the value must be between 1 and 10, inclusive.
For "highest", "latest" and "average", this field must be blank.</td>
For "highest", "latest" and "average", this field must be blank. If the Account and Course Level Outcome Mastery Scales flag is enabled, the calculation_int field does not need to be defined in the imported .csv. The calculation_int field will be determined by the account and course settings.</td>
</tr>
<tr>
<td>parent_guids</td>
@ -128,7 +128,7 @@ or learning outcome group is "active".</td>
<td>number</td>
<td></td>
<td>The number of points that define mastery for this learning outcome.
Must be blank for learning outcome groups.</td>
Must be blank for learning outcome groups. If the Account and Course Level Outcome Mastery Scales flag is enabled, the mastery_points field does not need to be defined in the imported .csv. The mastery_points field will be determined by the account and course settings.</td>
</tr>
<tr>
<td>ratings</td>
@ -138,7 +138,7 @@ Must be blank for learning outcome groups.</td>
tiers for the given outcome. The columns alternate in decreasing point order:
first, number of points for the tier, then tier description. This alternating
pattern continues until there are no more scoring tiers for this outcome.
These columns must be blank for learning outcome groups. See sample below.</td>
These columns must be blank for learning outcome groups. See sample below. If the Account and Course Level Outcome Mastery Scales flag is enabled, the ratings field does not need to be defined in the imported .csv. The ratings field will be determined by the account and course settings.</td>
</tr>
</table>