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

Prefix custom structures with _ to hide them #104

Merged
merged 1 commit into from
Sep 15, 2021
Merged

Conversation

tamasgal
Copy link
Member

Since the custom stuff is mostly for test coverage, it makes sense to hide it from the public API. Btw. it also collides with downstream code since the structs are usually defined there and otherwise there is a clash, see #95 (comment)

@codecov
Copy link

codecov bot commented Sep 15, 2021

Codecov Report

Merging #104 (b79dc41) into master (703079e) will not change coverage.
The diff coverage is 70.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #104   +/-   ##
=======================================
  Coverage   88.19%   88.19%           
=======================================
  Files          11       11           
  Lines        1330     1330           
=======================================
  Hits         1173     1173           
  Misses        157      157           
Impacted Files Coverage Δ
src/custom.jl 72.72% <70.00%> (ø)

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 703079e...b79dc41. Read the comment docs.

@tamasgal tamasgal merged commit 0b09969 into master Sep 15, 2021
@Moelf
Copy link
Member

Moelf commented Sep 15, 2021

I thought we already have LorentzVector for test coverage
https://codecov.io/gh/tamasgal/UnROOT.jl/src/master/src/custom.jl

so actually, if you don't need them to be inside UnROOT, feel free to delete them haha. Which will increase our coverage %!

@tamasgal
Copy link
Member Author

I'd rather add more tests 😆 I promise I'll do 😉

@Moelf
Copy link
Member

Moelf commented Sep 15, 2021

I mean they could be in the test for sure, I'm saying if you don't need experiment-specific structs live inside UnROOT.jl. I'm just unsure how much you've factored out and how much you still rely on what's inside UnROOT.jl for actual work, so we didn't touch it.

@tamasgal
Copy link
Member Author

I think I have factored out everything, so they are really only there for tests. I just realised there is this DAQHit where I experimented with an ultra fast in-place-interpretation by defining it as a primite type and hacking Base.getproperty. That's a huge miss in test coverage but I did not want to forget about it for future implementations of dynamic type and parser generation. I'll probably just remove it for now and create a gist or so...

@tamasgal tamasgal deleted the hide-custom-stuff branch September 15, 2021 19:39
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