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

fix links in modules api documentation 

also update small typos in a few other files

Test plan:
- Jenkins passes

Closes: DOC-1019

Change-Id: I257a525ba19e179f44518dae26d1d62a10f29536
Reviewed-on: https://gerrit.instructure.com/188174
Tested-by: Jenkins
Reviewed-by: Mysti Lilla <mysti@instructure.com>
Product-Review: Mysti Lilla <mysti@instructure.com>
QA-Review: Mysti Lilla <mysti@instructure.com>
This commit is contained in:
Erin Hallmark 2019-04-05 09:11:49 -06:00 committed by Mysti Lilla
parent 84f39235c0
commit 3f9aa85a81
3 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
app/controllers/announcements_api_controller.rb
View File

@ -56,7 +56,7 @@ class AnnouncementsApiController < ApplicationController
# a string of the name of the resource. Possible values are:
# "sections", "sections_user_count"
# if "sections" is passed, includes the course sections that are associated
# with the topic, if the topic is specific to sertain sections of the course.
# with the topic, if the topic is specific to certain sections of the course.
# If "sections_user_count" is passed, then:
# (a) If sections were asked for *and* the topic is specific to certain
# course sections sections, includes the number of users in each

8
app/controllers/context_modules_api_controller.rb
View File

@ -134,13 +134,13 @@ class ContextModulesApiController < ApplicationController
# too numerous to return inline. Callers must be prepared to use the
# {api:ContextModuleItemsApiController#index List Module Items API}
# if items are not returned.
# - "content_details": Requires include['items']. Returns additional
# - "content_details": Requires 'items'. Returns additional
# details with module items specific to their associated content items.
# Includes standard lock information for each item.
#
# @argument search_term [String]
# The partial name of the modules (and module items, if include['items'] is
# specified) to match and return.
# The partial name of the modules (and module items, if 'items' is
# specified with include[]) to match and return.
#
# @argument student_id
# Returns module completion information for the student with this id.
@ -195,7 +195,7 @@ class ContextModulesApiController < ApplicationController
# too numerous to return inline. Callers must be prepared to use the
# {api:ContextModuleItemsApiController#index List Module Items API}
# if items are not returned.
# - "content_details": Requires include['items']. Returns additional
# - "content_details": Requires 'items'. Returns additional
# details with module items specific to their associated content items.
# Includes standard lock information for each item.
#

2
app/controllers/discussion_topics_controller.rb
View File

@ -826,7 +826,7 @@ class DiscussionTopicsController < ApplicationController
#
# @argument specific_sections [String]
# A comma-separated list of sections ids to which the discussion topic
# should be made specific too. If it is not desired to make the discussion
# should be made specific to. If it is not desired to make the discussion
# topic specific to sections, then this parameter may be omitted or set to
# "all". Can only be present only on announcements and only those that are
# for a course (as opposed to a group).