cta-observatory / protopipe

Prototype data analysis pipeline for the Cherenkov Telescope Array Observatory
https://protopipe.readthedocs.io/en/latest/
Other
5 stars 13 forks source link

fixed missing import of QTable #188

Closed kosack closed 2 years ago

kosack commented 2 years ago

(also ran isort to optimize imports)

codecov[bot] commented 2 years ago

Codecov Report

Merging #188 (a9f459d) into master (85155ea) will increase coverage by 0.05%. The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master     #188      +/-   ##
==========================================
+ Coverage   63.06%   63.11%   +0.05%     
==========================================
  Files          28       28              
  Lines        2886     2890       +4     
==========================================
+ Hits         1820     1824       +4     
  Misses       1066     1066              
Impacted Files Coverage Δ
protopipe/benchmarks/operations.py 23.35% <100.00%> (+0.56%) :arrow_up:
protopipe/benchmarks/plot.py 14.10% <100.00%> (+0.55%) :arrow_up:
protopipe/benchmarks/utils.py 47.61% <100.00%> (+2.61%) :arrow_up:

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 85155ea...a9f459d. Read the comment docs.

kosack commented 2 years ago

Actually, that's not normally needed: it is however missing an __all__ entry, which is how sphinx determines what to document.

HealthyPear commented 2 years ago

Actually, that's not normally needed: it is however missing an __all__ entry, which is how sphinx determines what to document.

Oh I didn't know. Then if that works it's fine for me.

kosack commented 2 years ago

Yeah, if a module doesn't have an __all__ entry, then everything in it becomes public, even imports. Which is why then Sphinx picks it up.

HealthyPear commented 2 years ago

Yeah, if a module doesn't have an __all__ entry, then everything in it becomes public, even imports. Which is why then Sphinx picks it up.

I this is the case, I guess we can then also remove the :skip: directive(s) from the documentation file(s)

HealthyPear commented 2 years ago

Yeah, if a module doesn't have an __all__ entry, then everything in it becomes public, even imports. Which is why then Sphinx picks it up.

I this is the case, I guess we can then also remove the :skip: directive(s) from the documentation file(s)

Actually we have to: the 2 things together generate warnings, which are set to be trated as errors by the documentation build on readthedocs (which for the moment is the only versioned one, even though #175 will add support for versioning also when building elsewhere)