-
Notifications
You must be signed in to change notification settings - Fork 1.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update JSON Dictionary spec #2663
Conversation
FPP annotations must be ASCII character strings. You could replace Schrödinger with Schroedinger. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! Just one comment. In the type descriptor for a string type, I think the size
field should have the description "Maximum string size in bytes" and the field should be required.
Agreed, fixed! |
Note to self: there's an issue with the rendering of some tables in the spec on the website: https://nasa.github.io/fprime/Design/fpp-json-dict.html This could be the solution: https://github.com/orgs/community/discussions/23945#discussioncomment-3242285 |
nvm: very likely has to do with whitespaces https://www.reddit.com/r/github/comments/15gexlw/comment/juik4y3 Fixed |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
This state of the JSON dictionary spec is in sync with fpp-to-dict=2.1.0a7 (https://pypi.org/project/fprime-fpp-to-dict/2.1.0a7/) |
Change Description
Type Name
toType Descriptor
Enumerated Constant Descriptor
andStruct Member Descriptor
for sub-dictionaries that describe each conceptdescription
toannotation
throughout in the spec and added it where it was missingParameters
section after Events to respect the CTEP (Commands>Telemetry>Events>Parameter) orderRationale
Updating the spec with regards to feedback from inputting into the GDS / build system
Testing/Review Recommendations
Will be drastically easier to review with the "Display Rich Diff" option in the changed files