Skip to content
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

Add more proto documentation #381

Merged
merged 6 commits into from
Jul 22, 2020
Merged

Add more proto documentation #381

merged 6 commits into from
Jul 22, 2020

Conversation

2qx
Copy link
Contributor

@2qx 2qx commented Jul 7, 2020

Add more explanatory documentation to protoc methods, types and fields.

  • Makes no change to the protocol itself.
  • Adds specificity for terms used to refer to many things,
  • Adds synonyms for words used interchangeably
  • Aims to provides an outside audience a succinct explanation,
    or enough key terms to obtain more information elsewhere.
  • Note quirks and defaults, where possible.

@cpacia
Copy link
Contributor

cpacia commented Jul 7, 2020

Thanks for the PR. Will take a look shortly.

@cpacia
Copy link
Contributor

cpacia commented Jul 10, 2020

@2qx any chance you can update the method comments in bchrpc/server.go to match the new comments in the proto file?

@2qx
Copy link
Contributor Author

2qx commented Jul 10, 2020

Will do.

@2qx
Copy link
Contributor Author

2qx commented Jul 11, 2020

@cpacia, I matched the comments from the proto.

In addition, there were some trailing whitespace in the protofile and some whitespace lines that I removed from the proto for consistency with go fmt.

Copy link
Contributor

@zquestz zquestz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks this looks great!

@cpacia cpacia merged commit e6b6216 into gcash:master Jul 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants