Merge pull request #3798 from edx/ahodges/documentation/DOC402

Adaptive hint correct_answer must be lc

docs/en_us/course_authors/source/change_log.rst

@@ -24,8 +24,14 @@ May, 2014
        * Renamed the *Checking Student Progress and Issuing Certificates*
          section to :ref:`Checking Student Progress and Issuing Certificates`.
 
+   * - 
+     - Updated :ref:`Problem with Adaptive Hint` to reflect formatting
+       requirements for the Python script and the correct_answer attribute.
    * - 05/21/14
-     - Added warning that version 1 of the :ref:`Open Response Assessments<Open Response Assessment>` suite has been deprecated and added a link to the `new ORA information <http://edx-open-response-assessments.readthedocs.org/en/latest/>`_.
+     - Added warning that version 1 of the :ref:`Open Response Assessments<Open
+       Response Assessment>` suite has been deprecated and added a link to the
+       `new ORA information <http://edx-open-response-
+       assessments.readthedocs.org/en/latest/>`_.
    * - 05/16/14
      - Updated :ref:`Working with Video Components` to reflect UI changes.
    * - 05/14/14
@@ -74,7 +80,7 @@ April, 2014
    * - 04/28/14
      - Updated :ref:`Show or Hide the Course Wiki Page` to include note about Wiki content being available after you hide the Wiki page.
    * - 04/26/14
-     - Updated label information; added XML information to :ref:`Problem with Adaptive Hint`  
+     - Updated label information; added XML information to :ref:`Problem with Adaptive Hint`.  
    * - 04/24/14
      - Expanded the :ref:`Grades` chapter to include topics on interpreting the grade reports and student progress page.
    * -    

docs/en_us/course_authors/source/exercises_tools/problem_with_hint.rst

@@ -83,10 +83,10 @@ Template
 	  ans = str(student_answers[aid]).lower()
 	  print 'hint_fn called, ans=', ans
 	  hint = ''
-	  if 'INCORRECT ANSWER 1' in ans:
-	     hint = 'HINT FOR INCORRECT ANSWER 1'
-	  elif 'INCORRECT ANSWER 2' in ans:
-	     hint = 'HINT FOR INCORRECT ANSWER 2'
+	  if 'incorrect answer 1' in ans:
+	     hint = 'hint for incorrect answer 1'
+	  elif 'incorrect answer 2' in ans:
+	     hint = 'hint for incorrect answer 2'
 
 	  if hint:
 	    hint = "<font color='blue'>Hint: {0}</font>".format(hint)
@@ -95,13 +95,14 @@ Template
 	    <p>TEXT OF PROBLEM</p>
 	    <p>
 	      <customresponse cfn="test_str" expect="ANSWER">
-	        <textline correct_answer="ANSWER" label="LABEL TEXT"/>
+	        <textline correct_answer="answer" label="LABEL TEXT"/>
 	        <hintgroup hintfn="hint_fn"/>
 	      </customresponse>
 	    </p>
 	  </text>
 	</problem>
 
+.. note:: If the hints that you supply include characters, the letters must be lowercase.
 
 ========
 Tags
@@ -129,6 +130,7 @@ Tags
 
   .. list-table::
      :widths: 20 80
+     :header-rows: 1
 
      * - Attribute
        - Description
@@ -139,7 +141,10 @@ Tags
      * - hidden (optional)
        - If set to "true", students cannot see the response field.
      * - correct_answer (optional)
-       - Lists the correct answer to the problem.
+       - The answer to the problem. To supply a correct_answer value that
+         includes letters, all letters **must be lowercase**. (Students'
+         responses to the problem are not case sensitive. They can contain both
+         uppercase and lowercase letters.)
 
   Children
   
@@ -151,8 +156,9 @@ Tags
 
   .. list-table::
      :widths: 20 80
+     :header-rows: 1
 
      * - Attribute
        - Description
      * - hintfn
-       - Must be set to **hint_fn** (i.e., the tag must appear as ``<hintgroup hintfn="hint_fn"/>``).
\ No newline at end of file
+       - Must be set to **hint_fn** (that is, the tag must appear as ``<hintgroup hintfn="hint_fn"/>``).
\ No newline at end of file