[skip changelog] Remove comment that breaks gRPC documentation structure #2080
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
The "gPRC Reference" section of the documentation website is automatically generated from the code and comments in the
project's Protocol Buffers files. The documentation is automatically structured according to the structure of the
Protocol Buffers code using heading levels, and the documentation website uses these heading levels to generate a table
of contents to allow easy navigation of the documentation and an overview of its structure.
The generation happens in two steps:
Protocol Buffers -> Markdown -> HTML
A comment in a Protocol Buffers file included a decorative underline formed from a series of `-` characters. This
happens to be markup for an H2 heading in the Markup language. This caused an inadvertent creation of an inappropriate
heading named "BOOTSTRAP COMMANDS", which resulted in the documentation having the following incorrect structure:
- Protocol Documentation
- [...]
- cc/arduino/cli/commands/v1/board.proto
- [...]
- cc/arduino/cli/commands/v1/commands.proto
- [...]
- ArduinoCoreService
- BOOTSTRAP COMMANDS
- <List of cc.arduino.cli.commands.v1.ArduinoCoreService methods>
- cc/arduino/cli/commands/v1/common.proto
- [...]
- [...]
Instead of the correct structure:
- Protocol Documentation
- [...]
- cc/arduino/cli/commands/v1/board.proto
- [...]
- cc/arduino/cli/commands/v1/commands.proto
- [...]
- ArduinoCoreService
- <List of cc.arduino.cli.commands.v1.ArduinoCoreService methods>
- cc/arduino/cli/commands/v1/common.proto
- [...]
- [...]
This could be corrected by removing only the pointless decorative comment, leaving the "BOOTSTRAP COMMANDS" comment, but
I don't see any value in that comment and it introduced unpleasant caps lock prose content into the documentation so I
removed it as well.
per1234
added
topic: documentation
cmaglie
approved these changes
Feb 20, 2023
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.
Please check if the PR fulfills these requirements
See how to contribute
before creating one)
our contributing guidelines
UPGRADING.mdhas been updated with a migration guide (for breaking changes)What kind of change does this PR introduce?
Documentation fix
What is the current behavior?
The "gPRC Reference" section of the documentation website is automatically generated from the code and comments in the project's Protocol Buffers files. The documentation is automatically structured according to the structure of the Protocol Buffers code using heading levels, and the documentation website uses these heading levels to generate a table of contents to allow easy navigation of the documentation and an overview of its structure.
The generation happens in two steps:
Protocol Buffers -> Markdown -> HTML
A comment in a Protocol Buffers file included a decorative underline formed from a series of
-characters. This happens to be markup for an H2 heading in the Markdown language. This caused an inadvertent creation of an inappropriate H2 heading named "BOOTSTRAP COMMANDS", which resulted in the documentation having the following incorrect structure:cc/arduino/cli/commands/v1/board.protocc/arduino/cli/commands/v1/commands.protoArduinoCoreServicecc.arduino.cli.commands.v1.ArduinoCoreService>cc/arduino/cli/commands/v1/common.protoWhat is the new behavior?
The problematic decorative comment is removed to produce the correct documentation structure:
cc/arduino/cli/commands/v1/board.protocc/arduino/cli/commands/v1/commands.protoArduinoCoreServicecc.arduino.cli.commands.v1.ArduinoCoreService>cc/arduino/cli/commands/v1/common.protoDoes this PR introduce a breaking change, and is titled accordingly?
No breaking change.
Other information
I also removed the "BOOTSTRAP COMMANDS" comment because I don't see any value in it and it introduced unpleasant caps lock prose content into the documentation.