Add unified Description type for schema description handling#1
Merged
Add unified Description type for schema description handling#1
Conversation
Covers three gaps: unused SchemaDescriptionKind, missing block metadata enrichment, and hardcoded top-level descriptions. Introduces a unified Description type with mdDoc support for markdown-kind descriptions.
Four tasks: create Description module, integrate into OptionBuilder, integrate block descriptions in ModuleGenerator, integrate top-level descriptions in ModuleGenerator. TDD approach with complete code.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Descriptionmodule (lib/TerranixCodegen/Description.hs) that encapsulates description text + kind (plain/markdown), metadata enrichment, and rendering to hnixNExprASTbuildDescriptioninOptionBuilderwithDescription.fromAttribute+Description.toNExprDescription.fromBlocklib.mdDocfor proper rendering in NixOS module documentationCloses three description generation gaps:
SchemaDescriptionKindwas parsed but unused — now driveslib.mdDocwrappingTest plan
DescriptionSpec,OptionBuilderSpec,ModuleGeneratorSpec)nix flake checkpasses (build, format, lint)