Uploaded image for project: 'Moodle'
  1. Moodle
  2. MDL-18162

Incorrect phpdoc for forum_clean_search_terms function

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Trivial
    • Resolution: Fixed
    • Affects Version/s: 1.9.2, 2.0
    • Fix Version/s: 2.6.4, 2.7.1
    • Component/s: Forum
    • Labels:
    • Testing Instructions:
      Hide

      Nothing to test - documentation only fix.

      • Open mod/forum/search.php and find the forum_clean_search_terms function
        • Check that myself, the peer reviewer, and the integrator are not insane and can correctly identify a string
      Show
      Nothing to test - documentation only fix. Open mod/forum/search.php and find the forum_clean_search_terms function Check that myself, the peer reviewer, and the integrator are not insane and can correctly identify a string
    • Difficulty:
      Easy
    • Affected Branches:
      MOODLE_19_STABLE, MOODLE_20_STABLE
    • Fixed Branches:
      MOODLE_26_STABLE, MOODLE_27_STABLE
    • Pull from Repository:
    • Pull Master Branch:
      MDL-18162-master
    • Pull Master Diff URL:

      Description

      The documentation for the forum_clean_search_terms function indicates that it returns an array. However, in reality, it returns a string.

        Attachments

          Issue Links

          has been marked as being related by

          Bug - A problem which impairs or prevents Moodle from functioning correctly. MDLSITE-3138 Coding style guide should specify to use stdClass and not object in stdClass

          • Minor - Minor loss of function where workaround is possible
          • Closed

            Activity

              People

              Assignee:
              dobedobedoh Andrew Nicols
              Reporter:
              hchathi Hubert Chathi
              Peer reviewer:
              Ankit Agarwal
              Integrator:
              Sam Hemelryk
              Tester:
              Rajesh Taneja
              Participants:
              Component watchers:
              Andrew Nicols, Jun Pataleta, Michael Hawkins, Shamim Rezaie, Simey Lameze
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:
                Fix Release Date:
                14/Jul/14