Skip to content

[skip changelog] Add documentation for gRPC Debug service #703

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 29, 2020
Merged

[skip changelog] Add documentation for gRPC Debug service #703

merged 1 commit into from
May 29, 2020

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented May 13, 2020

Please check if the PR fulfills these requirements

  • What kind of change does this PR introduce?

Add explanatory comments for the Debug service of the gRPC interface to the source code. These comments will be included in the generated gRPC interface documentation.

  • What is the current behavior?

There is insufficient explanation of the gRPC interface in the documentation.

  • What is the new behavior?

Improved documentation of the gRPC interface.

  • Does this PR introduce a breaking change?

No

@cmaglie cmaglie added the topic: documentation Related to documentation for the project label May 15, 2020
Comments added to the .proto files are included in the generated gRPC interface documentation.
@per1234
Copy link
Contributor Author

per1234 commented May 15, 2020

I rebased to fix the merge conflict and added documentation for the new import_dir field:

    // Directory containing the compiled executable. If `import_dir` is not
    // specified, the executable is assumed to be in
    // `{sketch_path}/build/{fqbn}/`.
    string import_dir = 8;

@rsora rsora merged commit 4c4a1f5 into arduino:master May 29, 2020
@per1234 per1234 deleted the debug-service-documentation branch May 29, 2020 17:32
@per1234 per1234 self-assigned this Nov 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants