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

feat(docgen): improve examples #3479

Merged
merged 2 commits into from
Jun 21, 2024

Conversation

distractedm1nd
Copy link
Collaborator

@distractedm1nd distractedm1nd commented Jun 7, 2024

Improved examples for blob related types to be consistent throughout (Commitment, Proof, Blob, Namespace). Previous blob.Proof and blob.Commitment were not valid values.

Also added a valid example value for libhead.Hash

api/docgen/examples.go Outdated Show resolved Hide resolved
@codecov-commenter
Copy link

Codecov Report

Attention: Patch coverage is 66.66667% with 6 lines in your changes missing coverage. Please review.

Project coverage is 44.72%. Comparing base (2469e7a) to head (a9c1d24).
Report is 118 commits behind head on main.

Files Patch % Lines
api/docgen/examples.go 66.66% 3 Missing and 3 partials ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3479      +/-   ##
==========================================
- Coverage   44.83%   44.72%   -0.12%     
==========================================
  Files         265      273       +8     
  Lines       14620    15383     +763     
==========================================
+ Hits         6555     6880     +325     
- Misses       7313     7702     +389     
- Partials      752      801      +49     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@cristaloleg cristaloleg left a comment

Choose a reason for hiding this comment

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

SGTM

@distractedm1nd distractedm1nd merged commit 63a62be into celestiaorg:main Jun 21, 2024
28 checks passed
@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
area:rpc kind:feat Attached to feature PRs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants