Uorb improved docs - structure and comment format #24966
Draft
+224
−14
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
hamishwillee
force-pushed
the
uorb_improved_docs
branch
from
2808624 to
e199c33
Compare
hamishwillee
force-pushed
the
uorb_improved_docs
branch
from
e199c33 to
bad8602
Compare
|
/en/middleware/uorb.md
|
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.
The UORB docs have evolved organically, and so are not exhaustive, and are hard to extend. For example, when I just added ORB_QUEUE_LENGTH, there wasn't a clear section to add "magic fields".
In addition, we're adding a commenting syntax, and that should go in their too.
This attempts to build in an extensible structure for the message definition.
Rather than saying "A message looks like this and has these things" we'll split out sections defining rigorously the format for fields, array fields, constants, mandatory fields etc.
Not throwing away information, just making sure we are well set for future extension.
This follows after #24965 (it include a commit from there).