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.

Sign up for GitHub

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

Jump to bottom

refactor(protos): clean up crate rust doc first impression #56

Merged
merged 2 commits into from
Nov 6, 2024
Merged

refactor(protos): clean up crate rust doc first impression #56

merged 2 commits into from
Nov 6, 2024

Conversation

suchapalaver
Copy link
Contributor

@suchapalaver suchapalaver commented Nov 6, 2024 •
edited
Loading

Run cargo doc --open from the root of firehose-protos.

  • adds better doc comments to protobuffer doc comments
  • reorganizes what types we need to expose from the crate (such as BlockNumber)
  • fixes naming issues created by conflicting exports of different types of Block.

@linear Linear
Copy link

linear bot commented Nov 6, 2024

BACK-157 Clean up firehose-protos pt.2

We should follow gustavo's example in header-accumulator by focusing on how cargo doc --open generates documentation that should provide a quick and useful sense of what the crate offers.

reviewer: gustavo

@suchapalaver suchapalaver force-pushed the joseph/back-157-clean-up-firehose-protos-pt2 branch from d03effe to 42148d3 Compare November 6, 2024 19:29
gusinacio
gusinacio approved these changes Nov 6, 2024
View reviewed changes
Copy link
Contributor

@gusinacio gusinacio left a comment

Choose a reason for hiding this comment

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

LGTM

@suchapalaver suchapalaver merged commit 9cbf31f into main Nov 6, 2024
7 checks passed
@suchapalaver suchapalaver deleted the joseph/back-157-clean-up-firehose-protos-pt2 branch November 6, 2024 21:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gusinacio gusinacio gusinacio approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@suchapalaver @gusinacio