FLUID-5828: Fixes to ChangeApplier docs

Metadata

Source
FLUID-5828
Type
Task
Priority
Major
Status
Closed
Resolution
Migrated
Assignee
N/A
Reporter
Anastasia Cheetham
Created
2015-12-10T11:12:38.169-0500
Updated
2024-08-01T07:41:33.884-0400
Versions
N/A
Fixed Versions
N/A
Component
  1. Tech. Documentation

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!

Comments