From c73f73557b90f1f3e1834b1f6673ba4b7f024ad5 Mon Sep 17 00:00:00 2001 From: per1234 Date: Tue, 21 Feb 2023 07:19:42 -0800 Subject: [PATCH 1/2] [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 - - 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 - - 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. --- rpc/cc/arduino/cli/commands/v1/commands.proto | 3 --- 1 file changed, 3 deletions(-) diff --git a/rpc/cc/arduino/cli/commands/v1/commands.proto b/rpc/cc/arduino/cli/commands/v1/commands.proto index 03d8b470d41..45539aa9755 100644 --- a/rpc/cc/arduino/cli/commands/v1/commands.proto +++ b/rpc/cc/arduino/cli/commands/v1/commands.proto @@ -31,9 +31,6 @@ import "cc/arduino/cli/commands/v1/lib.proto"; // The main Arduino Platform service API service ArduinoCoreService { - // BOOTSTRAP COMMANDS - //------------------- - // Create a new Arduino Core instance rpc Create(CreateRequest) returns (CreateResponse) {} From ee9ae9d2b5a2b2a0bb7ccf77a76fbaa1ac70b4c8 Mon Sep 17 00:00:00 2001 From: Matteo Pologruto Date: Tue, 21 Feb 2023 11:31:18 +0100 Subject: [PATCH 2/2] Modify `board search --help` description to correctly explain the command's function --- internal/cli/board/search.go | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/internal/cli/board/search.go b/internal/cli/board/search.go index 0225374bc31..102e9ea1dae 100644 --- a/internal/cli/board/search.go +++ b/internal/cli/board/search.go @@ -34,9 +34,8 @@ import ( func initSearchCommand() *cobra.Command { var searchCommand = &cobra.Command{ Use: fmt.Sprintf("search [%s]", tr("boardname")), - Short: tr("List all known boards and their corresponding FQBN."), - Long: tr(`List all boards that have the support platform installed. You can search -for a specific board if you specify the board name`), + Short: tr("Search for a board in the Boards Manager."), + Long: tr(`Search for a board in the Boards Manager using the specified keywords.`), Example: "" + " " + os.Args[0] + " board search\n" + " " + os.Args[0] + " board search zero",