Skip to content

Commit 2826e54

Browse files
committed
Deprecate lessons_presentation_order
1 parent 99d07cc commit 2826e54

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

Diff for: source/includes/20170710/resources/_user.md.erb

+4-5
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Attribute | Data Type | Description
5656
`extra_study_autoplay_audio` | Boolean | Automatically play pronunciation audio for vocabulary during extra study.
5757
`lessons_autoplay_audio` | Boolean | Automatically play pronunciation audio for vocabulary during lessons.
5858
`lessons_batch_size` | Integer | Number of subjects introduced to the user during lessons before quizzing.
59-
`lessons_presentation_order` | String | The order in which lessons are presented. The options are `ascending_level_then_subject`, `shuffled`, and `ascending_level_then_shuffled`. The default (and best experience) is `ascending_level_then_subject`.
59+
`lessons_presentation_order` | String | This is a deprecated user preference. It always returns `ascending_level_then_subject`. Setting this preference will do nothing. It exists only to ensure existing consumers of this API don't break.
6060
`reviews_autoplay_audio` | Boolean | Automatically play pronunciation audio for vocabulary during reviews.
6161
`reviews_display_srs_indicator` | Boolean | Toggle for display SRS change indicator after a subject has been completely answered during review.
6262
`reviews_presentation_order` | String | The order in which reviews are presented. The options are `shuffled` and `lower_levels_first`. The default (and best experience) is `shuffled`.
@@ -122,9 +122,9 @@ Returns a summary of user information.
122122

123123
> Example Request
124124

125-
<%= partial('examples/PUT_shell', locals: { api_endpoint: 'user', params: { "user": { "preferences": { "lessons_autoplay_audio": true, "lessons_batch_size": 3, "lessons_presentation_order": "shuffled", "reviews_autoplay_audio": true, "reviews_display_srs_indicator": false } } } }) %>
125+
<%= partial('examples/PUT_shell', locals: { api_endpoint: 'user', params: { "user": { "preferences": { "lessons_autoplay_audio": true, "lessons_batch_size": 3, "reviews_autoplay_audio": true, "reviews_display_srs_indicator": false } } } }) %>
126126

127-
<%= partial('examples/PUT_javascript', locals: { api_endpoint: 'user', params: { "user": { "preferences": { "lessons_autoplay_audio": true, "lessons_batch_size": 3, "lessons_presentation_order": "shuffled", "reviews_autoplay_audio": true, "reviews_display_srs_indicator": false } } } }) %>
127+
<%= partial('examples/PUT_javascript', locals: { api_endpoint: 'user', params: { "user": { "preferences": { "lessons_autoplay_audio": true, "lessons_batch_size": 3, "reviews_autoplay_audio": true, "reviews_display_srs_indicator": false } } } }) %>
128128

129129
> Example Response
130130

@@ -151,7 +151,7 @@ Returns a summary of user information.
151151
"extra_study_autoplay_audio": false,
152152
"lessons_autoplay_audio": true,
153153
"lessons_batch_size": 3,
154-
"lessons_presentation_order": "shuffled",
154+
"lessons_presentation_order": "ascending_level_then_subject",
155155
"reviews_autoplay_audio": true,
156156
"reviews_display_srs_indicator": false,
157157
"reviews_presentation_order": "shuffled"
@@ -176,7 +176,6 @@ Name | Data Type | Required?
176176
`extra_study_autoplay_audio` | Boolean | false
177177
`lessons_autoplay_audio` | Boolean | false
178178
`lessons_batch_size` | Integer | false
179-
`lessons_presentation_order` | String | false
180179
`reviews_autoplay_audio` | Boolean | false
181180
`reviews_display_srs_indicator` | Boolean | false
182181
`reviews_presentation_order` | String | false

0 commit comments

Comments
 (0)