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

Improve public API #57

Merged
merged 8 commits into from
May 5, 2021
Merged

Improve public API #57

merged 8 commits into from
May 5, 2021

Conversation

adlerjohn
Copy link
Member

Partially addresses #12.

Don't export dataSquare methods, and instead only export ExtendedDataSquare methods that wrap those. Functionally mostly the same, except Row and Col now return copies, so the caller can't accidentally write to internal slices in a bad way.

@adlerjohn adlerjohn requested a review from liamsi May 5, 2021 03:15
@adlerjohn adlerjohn self-assigned this May 5, 2021
@codecov
Copy link

codecov bot commented May 5, 2021

Codecov Report

Merging #57 (3533af6) into master (5a692bf) will decrease coverage by 0.24%.
The diff coverage is 72.34%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #57      +/-   ##
==========================================
- Coverage   76.70%   76.45%   -0.25%     
==========================================
  Files           9        9              
  Lines         382      378       -4     
==========================================
- Hits          293      289       -4     
  Misses         57       57              
  Partials       32       32              
Impacted Files Coverage Δ
bit_matrix.go 82.85% <ø> (ø)
tree.go 100.00% <ø> (+16.66%) ⬆️
extendeddatasquare.go 44.44% <60.00%> (+4.44%) ⬆️
extendeddatacrossword.go 71.42% <70.83%> (ø)
datasquare.go 93.18% <84.61%> (+0.25%) ⬆️
codecs.go 33.33% <0.00%> (+22.22%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5a692bf...3533af6. Read the comment docs.

Copy link
Member

@liamsi liamsi left a comment

Choose a reason for hiding this comment

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

Great! I think we can merge this as is. Though we should open an issue to make sure we test all public APIs (including methods introduced here) and about test coverage.

@adlerjohn adlerjohn merged commit ac0f1e1 into master May 5, 2021
@adlerjohn adlerjohn deleted the adlerjohn/public_api_exported branch May 5, 2021 13:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants