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

docs(blob): update godoc comments to better match what Get and GetProof actually do #3530

Merged
merged 6 commits into from
Jul 5, 2024

Conversation

ramin
Copy link
Contributor

@ramin ramin commented Jun 26, 2024

Refs #3335

Attempts to create more accurate doc/comments on Get and GetProof in blob/service.go to improve legibility and comprehension of how these methods behave to API consumers

specifically cc @vgonkivs

@ramin ramin added the kind:docs For solely documentation PRs label Jun 26, 2024
blob/service.go Outdated Show resolved Hide resolved
blob/service.go Outdated Show resolved Hide resolved
Co-authored-by: Vlad <13818348+walldiss@users.noreply.github.com>
@ramin ramin requested a review from walldiss July 1, 2024 08:38
renaynay
renaynay previously approved these changes Jul 4, 2024
@ramin ramin enabled auto-merge (squash) July 4, 2024 12:30
blob/service.go Outdated Show resolved Hide resolved
Copy link
Member

@renaynay renaynay left a comment

Choose a reason for hiding this comment

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

thanks for clarification on the proof

@ramin ramin merged commit 1828f78 into main Jul 5, 2024
28 checks passed
@ramin ramin deleted the docs/ramin/blob-comment branch July 5, 2024 08:36
@vgonkivs vgonkivs mentioned this pull request Jul 5, 2024
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind:docs For solely documentation PRs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants