Clean up json schema descriptions and generated documentation #311
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
The json schema contained several spurious space, astrix and other bit of text. Removing these makes the documentation much easier to read.
8 tasks
luke-hill
reviewed
Jul 18, 2025
| @@ -2,7 +2,6 @@ | |||
| "$schema": "https://json-schema.org/draft/2020-12/schema", | |||
| "$id": "Envelope.json", | |||
| "additionalProperties": false, | |||
| "description": "When removing a field, replace it with reserved, rather than deleting the line.\n When adding a field, add it to the end and increment the number by one.\n See https://developers.google.com/protocol-buffers/docs/proto#updating for details\n\n*\n All the messages that are passed between different components/processes are Envelope\n messages.", | |||
There was a problem hiding this comment.
Is this description meant to have gone?
There was a problem hiding this comment.
Yes. I don't think the protobuf instructions matter anymore.
luke-hill
approved these changes
Jul 18, 2025
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.
⚡️ What's your motivation?
The json schema contained several spurious space, astrix and other bit of text. Removing these makes the documentation much easier to read.
There are other mistakes still present but they're not so easy to spot automatically.
🏷️ What kind of change is this?
📋 Checklist: