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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

chore(grpc-mock): add docs #1637

wants to merge 5 commits into from
+546 −1

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

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

At least 1 approving review is required to merge this pull request.

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
1 participant
@ethanoroshiba