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

docs: refine rust docs for public api #59

Merged
merged 5 commits into from
Nov 26, 2024
Merged

docs: refine rust docs for public api #59

merged 5 commits into from
Nov 26, 2024
+296 −110

Conversation

suchapalaver
Copy link
Contributor

@suchapalaver suchapalaver commented Nov 8, 2024 •
edited
Loading

To review, cd into each crate and from the root of each crate run cargo doc --open.

@suchapalaver suchapalaver self-assigned this Nov 8, 2024
@linear Linear
Copy link

linear bot commented Nov 8, 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 changed the title docs(protos): refine rust docs for public api docs: refine rust docs for public api Nov 9, 2024
@suchapalaver suchapalaver force-pushed the joseph/back-157-clean-up-firehose-protos-pt2 branch 3 times, most recently from d26efcf to 219c07e Compare November 9, 2024 13:49
@suchapalaver suchapalaver marked this pull request as draft November 10, 2024 08:54
@suchapalaver suchapalaver force-pushed the joseph/back-157-clean-up-firehose-protos-pt2 branch 3 times, most recently from 6cf5752 to 6103a38 Compare November 10, 2024 09:22
@suchapalaver suchapalaver marked this pull request as ready for review November 14, 2024 07:34
@suchapalaver suchapalaver force-pushed the joseph/back-157-clean-up-firehose-protos-pt2 branch from 6103a38 to a581b20 Compare November 26, 2024 14:27
@suchapalaver suchapalaver force-pushed the joseph/back-157-clean-up-firehose-protos-pt2 branch from a581b20 to 8bcf621 Compare November 26, 2024 14:30
@suchapalaver suchapalaver force-pushed the joseph/back-157-clean-up-firehose-protos-pt2 branch from c9bdd47 to 880c05f Compare November 26, 2024 15:19
@suchapalaver suchapalaver merged commit d2436cb into main Nov 26, 2024
7 checks passed
@suchapalaver suchapalaver deleted the joseph/back-157-clean-up-firehose-protos-pt2 branch November 26, 2024 16:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pedrohba1 pedrohba1 pedrohba1 approved these changes

@gusinacio gusinacio Awaiting requested review from gusinacio

Assignees

@suchapalaver suchapalaver

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

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