Uploaded image for project: 'Tapestry'
  1. Tapestry
  2. TAPESTRY-2583

Documentation on Block component needs warning text

    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 4.1.5
    • Fix Version/s: 4.1.7
    • Component/s: Documentation
    • Labels:
      None

      Description

      The documentation page

      http://tapestry.apache.org/tapestry4.1/components/general/block.html

      says "When a Block component renders normally, it does absolutely nothing."

      It is not quite correct, because the pageBeginRender() method of the Block will always be executed
      (even if the Block is never rendered).
      And the method usually contains some expensive database calls that would better be avoided.

      I propose to add a warning text into the documentation, like this:

      "NB: the pageBeginRender() method of the Block will always be executed (even if the Block is never rendered)"

        Attachments

          Activity

            People

            • Assignee:
              andyhot Andreas Andreou
              Reporter:
              altumano Albert Tumanov
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: