Align module documentation with inline module implementations#240
Open
SemTiOne wants to merge 4 commits into
Open
Align module documentation with inline module implementations#240SemTiOne wants to merge 4 commits into
SemTiOne wants to merge 4 commits into
Conversation
SemTiOne
changed the title
Owner
|
I would like to have #235 completed before reviewing this |
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
2 participants
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.
Pull Request
Summary
module.yaml is the only required file. Compose lives inline at
spec.implementation.compose, config validated viaspec.configSchema. README.md optional, unread by validator.Also fixed a wrong custom-image example, added provides/consumes to Dependency rules.
Closes #231, supersedes #141.
Type Of Change
User Impact
Module authoring docs now match
module.yaml/schemas/module.schema.json, no more false required-file claims.Validation
Docs-only change. All tests passed.
python -m unittest discover -s tests -p "*.py"Checklist