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

Improve documentation of PrefsEditorLoader

    Details

    • Type: Improvement
    • Status: Open
    • Priority: Blocker
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: 3.0
    • Component/s: Tech. Documentation
    • Labels:
      None

      Description

      Our prefs framework documentation doesn't effectively communicate what the PrefsEditorLoader component does. It's described in the file LocalizationInThePreferencesFramework.md, but it would likely never occur to anyone to look for the information there. Now that the type of prefs editor is specified using a grade passed to the PrefsEditorLoader, we should probably surface that information more clearly.

      In particular:

      In the file AuxiliarySchemaForPreferencesFramework.md, the "loaderGrades" property is described, but there's no explanation of just what a prefsEditorLoader is (nor any link to any explanation), and there's no explanation of why you might want to apply particular grades to one (other than modifying the default prefs editor type, which is mentioned almost as an aside).

      The information in LocalizationInThePreferencesFramework.md that describes the PrefsEditorLoader should be double-checked for accuracy. It currently make the component sound like it's primarily responsible for loading resources, but given that it also loads the actual prefs editor itself, there might be more information that might be useful.

      We should consider moving the "Preferences Editor Component Hierarchy" description out of the Localization page into a more general spot – and ensuring it is up-to-date. I suspect that such an overview might be helpful to users of the prefs framework, and could be referenced by other places in the docs that talk about grades, etc. that affect the process (such as the "loaderGrades" property).

        Attachments

          Activity

            People

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

              Dates

              • Created:
                Updated: