docs: fix module schema property description for object types - #7049
Open
sundeep8967 wants to merge 1 commit into
Open
docs: fix module schema property description for object types#7049sundeep8967 wants to merge 1 commit into
sundeep8967 wants to merge 1 commit into
Conversation
github-actions
Bot
added
the
documentation
When rendering schema property documentation, module_property.tmpl previously appended 'Each object in <name> list supports the following keys:' to all properties with nested properties, regardless of whether the property was an array of items or a single object. Fix module_property.tmpl to distinguish between list types (items) and single object types (properties/patternProperties directly), rendering 'The <name> object supports the following keys:' for object properties. Fixes canonicalGH-7046
sundeep8967
force-pushed
the
fix/docs-schema-object-property-description
branch
from
September 5, 2026 09:38
0fdba37 to
a0601f2
Compare
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
1 participant
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.
Problem
When rendering module configuration schema documentation (such as for
write_files),module_property.tmplappended "Each object in<name>list supports the following keys:" to all properties with nested properties, even when the property is a single object (e.g.source), rather than a list of objects.Solution
doc/rtd/templates/module_property.tmplto distinguish between list types (itemscontaining properties) and single object types.<name>object supports the following keys:".Fixes #7046
Testing