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

chore(grpc-mock): add docs #1637

Merged
merged 7 commits into from
Nov 4, 2024
Merged

chore(grpc-mock): add docs #1637

merged 7 commits into from
Nov 4, 2024

Conversation

ethanoroshiba
Copy link
Contributor

@ethanoroshiba ethanoroshiba commented Oct 4, 2024 •
edited
Loading

Summary

Added docs to the astria-grpc-mock crate.

Background

Entire crate was missing documentation.

Changes

  • Added README
  • Added doc comments to all public items.
  • Made DynamicResponse private, as it had no need to be public.

Testing

Passing all doc tests.

Related Issues

closes #901

@ethanoroshiba ethanoroshiba marked this pull request as ready for review October 4, 2024 20:08
@ethanoroshiba ethanoroshiba requested review from a team as code owners October 4, 2024 20:08
Fraser999
Fraser999 approved these changes Nov 4, 2024
View reviewed changes
Copy link
Contributor

@Fraser999 Fraser999 left a comment

Choose a reason for hiding this comment

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

Nice job!

@ethanoroshiba ethanoroshiba added this pull request to the merge queue Nov 4, 2024
Merged via the queue into main with commit 3cabf59 Nov 4, 2024
46 checks passed
@ethanoroshiba ethanoroshiba deleted the ENG-85/mock_grpc_docs branch November 4, 2024 16:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Fraser999 Fraser999 Fraser999 approved these changes

@noot noot Awaiting requested review from noot noot is a code owner automatically assigned from astriaorg/rust-reviewers

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

Successfully merging this pull request may close these issues.

Create a README, proper doc comments, example usage
2 participants
@ethanoroshiba @Fraser999