Uploaded image for project: 'Fluid Infusion'
  1. Fluid Infusion
  2. FLUID-5828

Fixes to ChangeApplier docs

    XMLWordPrintable

    Details

    • Type: Task
    • Status: Open
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Tech. Documentation
    • Labels:
      None

      Description

      Some issues were found with the ChangeApplier.html and ChangeApplierAPI.html pages:

      ChangeApplier.html:

      • "model state" link goes to Framework Concepts page, but not immediately clear what the user should read from there. "Model state" isn't even mentioned on the Framework Concepts page.
      • Acronym "POJO" is used but not defined. Should we define such terms?
        suggestion: link it to https://en.wikipedia.org/wiki/Plain_Old_Java_Object ?

      ChangeApplierAPI.html

      • Invoker link goes to "compact" section of that document.
      • should invoker link go to Invoker doc and the "compact" word previous to it go to the "Compact" section of the invoker document?
      • this should be re-examined, since there's nothing in the 'compact' section of the invoker documentation!

        Attachments

          Activity

            People

            Assignee:
            Unassigned Unassigned
            Reporter:
            anastasia Anastasia Cheetham
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Dates

              Created:
              Updated: