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

PHPDocs of resolve_image_location are partially inaccurate

    XMLWordPrintable

Details

    • Bug
    • Status: Closed
    • Minor
    • Resolution: Fixed
    • 3.1.5, 3.2.2, 3.3
    • 3.1.6, 3.2.3
    • Themes

    Description

      During testing of MDL-58485, mudrd8mz correctly pointed out that the phpdocs of the \theme_config::resolve_image_location function (particularly, for the parameter $svg are inaccurate:

      @param bool $svg If set to true SVG images will also be looked for.
      

      However, implementation of that function explicitly handles the case that $svg is null, which results in a fallback to browser support of SVGs. Therefore, docs should be updated to

      @param bool|null $svg Should SVG images be also looked for, null for auto-detection of browser support.
      

      ... I'll prepare a patch.

      Attachments

        Issue Links

          Activity

            People

              jan.dagefoerde Jan Dageförde
              jan.dagefoerde Jan Dageförde
              Ankit Agarwal Ankit Agarwal
              Andrew Lyons Andrew Lyons
              Andrew Lyons Andrew Lyons
              Huong Nguyen, Bas Brands, Mathew May
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:
                8/May/17