Surface device.yml descriptions in the runtime generated modules - #54
Open
bruno-f-cruz wants to merge 3 commits into
Open
Surface device.yml descriptions in the runtime generated modules#54bruno-f-cruz wants to merge 3 commits into
device.yml descriptions in the runtime generated modules#54bruno-f-cruz wants to merge 3 commits into
Conversation
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.
The runtime schema generator (
harp.device.schema._emit) built register, payload field, and mask classes at runtime but silently dropped everydescription:fromdevice.yml. This surfaces them as__doc__on the emitted objects, matching what the static generator (harp-tech/generators) documents for the same schema:register.description:__doc__on the register classpayloadSpec.<member>.description:__doc__on itsField/GroupMaskdescriptorbitMask/groupMask.description:__doc__on the emitted enum classmaskValue.description:__doc__on the individual enum memberCloses #53