Moodle
  1. Moodle
  2. MDL-40275

Confusing documentation of has_config method

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Trivial Trivial
    • Resolution: Fixed
    • Affects Version/s: 2.3.7, 2.4.4, 2.5, 2.6
    • Fix Version/s: 2.3.8, 2.4.5, 2.5.1
    • Component/s: Documentation
    • Labels:

      Description

      The current documentation of the has_config method in block_base is:

      Subclasses should override this and return true if the
      subclass block has a config_global.html file.

      This is not correct and is confusing. It should read something like:

      Subclasses should override this and return true if the
      subclass block has a settings.php file.

        Gliffy Diagrams

          Activity

          Hide
          Michael Aherne added a comment -

          I have added a pull request for this.

          Show
          Michael Aherne added a comment - I have added a pull request for this.
          Hide
          Michael Aherne added a comment -

          Sorry, I know this is a very trivial issue, but it caused me a fair bit of trouble when trying to work out why a block's settings weren't appearing!

          Show
          Michael Aherne added a comment - Sorry, I know this is a very trivial issue, but it caused me a fair bit of trouble when trying to work out why a block's settings weren't appearing!
          Hide
          Petr Skoda added a comment -

          Thanks, sending to integration!

          Show
          Petr Skoda added a comment - Thanks, sending to integration!
          Hide
          Eloy Lafuente (stronk7) added a comment -

          The main moodle.git repository has just been updated with latest weekly modifications. You may wish to rebase your PULL branches to simplify history and avoid any possible merge conflicts. This would also make integrator's life easier next week.

          TIA and ciao

          Show
          Eloy Lafuente (stronk7) added a comment - The main moodle.git repository has just been updated with latest weekly modifications. You may wish to rebase your PULL branches to simplify history and avoid any possible merge conflicts. This would also make integrator's life easier next week. TIA and ciao
          Hide
          Eloy Lafuente (stronk7) added a comment -

          Integrated (23, 24, 25 & master), thanks!

          Show
          Eloy Lafuente (stronk7) added a comment - Integrated (23, 24, 25 & master), thanks!
          Hide
          Eloy Lafuente (stronk7) added a comment -

          No testing required. Just confirm settings.php apply to all the target versions. It does, so passing this.

          Show
          Eloy Lafuente (stronk7) added a comment - No testing required. Just confirm settings.php apply to all the target versions. It does, so passing this.
          Hide
          Damyon Wiese added a comment -

          This issue is fixed! Hurray! Hurray!
          Your issue is fixed, what a wonderful day!

          Cheers, Damyon

          Show
          Damyon Wiese added a comment - This issue is fixed! Hurray! Hurray! Your issue is fixed, what a wonderful day! Cheers, Damyon

            People

            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: