Document enumeration path map in the spec. #5203
Merged
Conversation
This file contains 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
teo-tsirpanis
commented
Jul 19, 2024
Comment on lines
+756
to
+765
| // enumeration_num (uint32_t) | ||
| // enumeration_name_length #1 (uint32_t) | ||
| // enumeration_name_chars #1 (string) | ||
| // enumeration_filename_length #1 (uint32_t) | ||
| // enumeration_filename_chars #1 (string) | ||
| // enumeration_name_length #2 (uint32_t) | ||
| // enumeration_name_chars #2 (string) | ||
| // enumeration_filename_length #2 (uint32_t) | ||
| // enumeration_filename_chars #2 (string) | ||
| // ... |
There was a problem hiding this comment.
I believe these inline storage format comments should be removed. There must be a single source of truth for the storage format, and that will be in format_spec.
KiterLuc
approved these changes
Jul 25, 2024
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.
SC-51428
I noticed that the array schema format specification does not include the enumeration name-path map introduced in #4051. This PR updates the documentation.
I used the term "enumeration filename" to describe the string written after the enumeration name because it is just the file's name, and updated previous usages of "enumeration pathname" or "enumeration URI" in code.
TYPE: NO_HISTORY
DESC: Added documentation for the enumeration path map in array scehmas, present since format version 20.