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: improve doc comments #716

Merged
merged 4 commits into from
Sep 16, 2022
Merged

Conversation

rootulp
Copy link
Collaborator

@rootulp rootulp commented Sep 16, 2022

Spun out of #691 because these improvements are can be reviewed & merged independently

Spun out of universal share encoding because these improvements are
can be reviewed & merged independently
@rootulp rootulp added the documentation Improvements or additions to documentation label Sep 16, 2022
@rootulp rootulp self-assigned this Sep 16, 2022
@rootulp rootulp enabled auto-merge (squash) September 16, 2022 01:17
@celestiaorg celestiaorg deleted a comment from codecov-commenter Sep 16, 2022
@celestiaorg celestiaorg deleted a comment from codecov-commenter Sep 16, 2022
@codecov-commenter
Copy link

Codecov Report

Merging #716 (f83a44c) into main (27632dd) will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main     #716   +/-   ##
=======================================
  Coverage   46.22%   46.22%           
=======================================
  Files          33       33           
  Lines        3217     3217           
=======================================
  Hits         1487     1487           
  Misses       1619     1619           
  Partials      111      111           
Impacted Files Coverage Δ
pkg/prove/proof.go 82.48% <ø> (ø)
pkg/shares/shares.go 100.00% <ø> (ø)
pkg/shares/split_compact_shares.go 84.00% <ø> (ø)
pkg/shares/parse_compact_shares.go 77.77% <100.00%> (ø)
pkg/shares/parse_sparse_shares.go 88.60% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

evan-forbes
evan-forbes previously approved these changes Sep 16, 2022
Copy link
Member

@evan-forbes evan-forbes left a comment

Choose a reason for hiding this comment

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

disabled auto merge to allow the chance to respond to optional change, hope that's okay

pkg/shares/shares.go Show resolved Hide resolved
x/payment/types/payfordata_test.go Outdated Show resolved Hide resolved
@rootulp rootulp merged commit 566b3d4 into celestiaorg:main Sep 16, 2022
@rootulp rootulp deleted the rp/improve-doc-comments branch September 16, 2022 16:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants