Skip to content

[skip changelog] Add documentation for common and general components of the gRPC interface #686

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 8, 2020
Merged

[skip changelog] Add documentation for common and general components of the gRPC interface #686

merged 1 commit into from
May 8, 2020

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented May 6, 2020

Please check if the PR fulfills these requirements

  • What kind of change does this PR introduce?

Add explanatory comments for common and general components 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

@per1234 per1234 added topic: documentation Related to documentation for the project component/gRPC labels May 6, 2020
…of the gRPC interface

Comments added to the .proto files are included in the generated gRPC interface documentation.
@per1234
Copy link
Contributor Author

per1234 commented May 7, 2020

I did a force push to wrap the comments at 80 characters, following the existing style convention.

@rsora rsora self-requested a review May 7, 2020 11:50
@per1234 per1234 merged commit 4021535 into arduino:master May 8, 2020
@per1234 per1234 deleted the general-grpc-documentation branch May 8, 2020 09:12
@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.

2 participants