Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-18025

Missing field classes in Sphinx config docs

    Details

    • Type: Bug
    • Status: To Do
    • Resolution: Unresolved
    • Fix Version/s: None
    • Component/s: pex_config
    • Labels:
      None
    • Templates:
    • Story Points:
      2
    • Team:
      Data Access and Database

      Description

      The classes ConfigInstanceDict and RegistryInstanceDict are essential to using ConfigChoiceField and RegistryField, respectively, as these are the classes that are actually visible when inspecting a config. However, there does not appear to be any Sphinx documentation for these classes, and there is certainly no link from the much more visible *Field class docs.

      The same may apply to the instance counterparts of other fields (Dict, ConfigDict, List), but I'm less familiar with how important they are for users. Note that ConfigurableInstance is already documented.

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              krzys Krzysztof Findeisen
              Watchers:
              Krzysztof Findeisen
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:

                Summary Panel