Skip to content

Fill in missing description fields in transformer_model.yaml #240

@amc-corey-cox

Description

@amc-corey-cox

The schema YAML has real description gaps that the regenerated docs (#238) now visibly expose. Audited via schemaview.class_induced_slots() over every concrete class.

8 concrete classes with no description:

  • Any
  • PrefixDerivation
  • UnitConversionConfiguration
  • StringificationConfiguration
  • AggregationOperation
  • GroupingOperation
  • PivotOperation
  • KeyVal

38 distinct slots with no description: somewhere they appear

add, aggregation_operation, cast_collection_as, class_derivations, class_name, copy_directives, delimiter, dictionary_key, direction, element_name, expr, hide, invalid_value_handling, is_a, key, mirror_source, mixins, null_handling, operator, over_slots, range, reversed, slot_derivations, slot_name, source_magnitude_slot, source_unit, source_unit_scheme, source_unit_slot, stringification, syntax, target_magnitude_slot, target_unit, target_unit_scheme, target_unit_slot, type_designator, unit_conversion, unmelt_to_slots, value

The unit-conversion family (source_unit, target_unit, source_unit_scheme, target_unit_scheme, source_unit_slot, target_unit_slot, source_magnitude_slot, target_magnitude_slot, unit_conversion) is the largest cluster — likely worth a single pass with shared phrasing.

Once the descriptions land, regenerate with make gendoc and commit — the CI drift check from #234 will enforce this going forward.

Surfaced during the audit of #238.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions