pymmcore-plus / useq-schema

An implementation agnostic schema for describing a sequence of events during a multi-dimensional imaging acquisition.
https://pymmcore-plus.github.io/useq-schema/
BSD 3-Clause "New" or "Revised" License
15 stars 5 forks source link

docs: update units of exposure in docstring to ms #114

Closed tlambert03 closed 1 year ago

tlambert03 commented 1 year ago

We've been treating exposure everywhere (in pymmcore-plus) as if it's in milliseconds. core.setExposure assumes milliseconds. So this changes the docstring accordingly. it's a "breaking" change but I doubt that anyone besides pymmcore plus has been consuming this yet

codecov[bot] commented 1 year ago

Codecov Report

Patch and project coverage have no change.

Comparison is base (c80ed5e) 96.50% compared to head (9778d80) 96.50%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #114 +/- ## ======================================= Coverage 96.50% 96.50% ======================================= Files 13 13 Lines 716 716 ======================================= Hits 691 691 Misses 25 25 ``` | [Files Changed](https://app.codecov.io/gh/pymmcore-plus/useq-schema/pull/114?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pymmcore-plus) | Coverage Δ | | |---|---|---| | [src/useq/\_channel.py](https://app.codecov.io/gh/pymmcore-plus/useq-schema/pull/114?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pymmcore-plus#diff-c3JjL3VzZXEvX2NoYW5uZWwucHk=) | `92.59% <ø> (ø)` | | | [src/useq/\_mda\_event.py](https://app.codecov.io/gh/pymmcore-plus/useq-schema/pull/114?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pymmcore-plus#diff-c3JjL3VzZXEvX21kYV9ldmVudC5weQ==) | `85.71% <ø> (ø)` | |

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