Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit c73f735

Browse filesBrowse files
per1234per1234
authored
[skip changelog] Remove comment that breaks gRPC documentation structure (#2080)
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.
1 parent 940c945 commit c73f735
Copy full SHA for c73f735

File tree

Expand file treeCollapse file tree

1 file changed

+0
-3
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+0
-3
lines changed

‎rpc/cc/arduino/cli/commands/v1/commands.proto

Copy file name to clipboardExpand all lines: rpc/cc/arduino/cli/commands/v1/commands.proto
-3Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,6 @@ import "cc/arduino/cli/commands/v1/lib.proto";
3131

3232
// The main Arduino Platform service API
3333
service ArduinoCoreService {
34-
// BOOTSTRAP COMMANDS
35-
//-------------------
36-
3734
// Create a new Arduino Core instance
3835
rpc Create(CreateRequest) returns (CreateResponse) {}
3936

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.