search

ubermag / discretisedfield

Python package for the analysis and visualisation of finite-difference fields.
http://ubermag.github.io
BSD 3-Clause "New" or "Revised" License
19 stars 13 forks source link

create valid docs #468

Closed samjrholt closed 1 year ago

lang-m commented 1 year ago

@samjrholt How do we want to proceed with this?

codecov-commenter commented 1 year ago

Codecov Report

Patch coverage has no change and project coverage change: -0.05% :warning:

Comparison is base (56c7f74) 93.42% compared to head (56929a1) 93.38%. Report is 22 commits behind head on master.

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #468 +/- ## ========================================== - Coverage 93.42% 93.38% -0.05% ========================================== Files 28 28 Lines 3013 3040 +27 ========================================== + Hits 2815 2839 +24 - Misses 198 201 +3 ``` [see 1 file with indirect coverage changes](https://app.codecov.io/gh/ubermag/discretisedfield/pull/468/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ubermag)

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

lang-m commented 1 year ago

The changes look good. Final question: should we mention the word intersection in

When you perform an operation on these fields, the resulting valid attribute is determined by the logical AND operation on the valid attribute of the initial fields.

Please do as you think is best and merge afterwards.