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

remove 'the' from API doc generated nicknames 

Auto-generated method names sometimes have 'the' in them. Remove 'the' to be consistent with the removal of articles 'a' and 'an'.

Test Plan:
- The following APIs should no longer have "the" in their
  nicknames (autogenerated JSON files):

  Accounts API:
    get_the_sub_accounts_of_account
    change_the_domains_for_account

  Assignments API:
    redirect_to_the_assignment_override_for_group
    redirect_to_the_assignment_override_for_section

  Discussion Topics API:
    get_the_full_topic_courses
    get_the_full_topic_groups
    get_the_full_topic_collection_items

  Groups API:
    list_the_groups_available_in_context_accounts
    list_the_groups_available_in_context_courses

  Quiz Statistics API:
    fetching_the_latest_quiz_statistics
    create_the_quiz_submission_start_quiz_taking_session
    complete_the_quiz_submission_turn_it_in

  Users API:
    list_the_activity_stream_self
    list_the_activity_stream_activity_stream
    list_the_todo_items

Fixes SIS-312

Change-Id: I6de521305605fe75b399889563f6d0b290cdf468
Reviewed-on: https://gerrit.instructure.com/35917
Tested-by: Jenkins <jenkins@instructure.com>
Reviewed-by: Ken Romney <kromney@instructure.com>
QA-Review: Jeremy Putnam <jeremyp@instructure.com>
Product-Review: Eric Adams <eadams@instructure.com>
This commit is contained in:
Duane Johnson 2014-06-04 14:26:15 -06:00 committed by Eric Adams
parent 71e5e53220
commit 21de3036c0
1 changed files with 1 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/api/fulldoc/html/swagger/method_view.rb
View File

@ -24,6 +24,7 @@ class MethodView < HashView
def nickname def nickname
summary.downcase. summary.downcase.
gsub(/ the /, ' ').
gsub(/ an? /, ' '). gsub(/ an? /, ' ').
gsub(/[^a-z]+/, '_'). gsub(/[^a-z]+/, '_').
gsub(/^_+|_+$/, '') gsub(/^_+|_+$/, '')