teamtomo / starfile

STAR file I/O in Python
https://teamtomo.org/starfile/
BSD 3-Clause "New" or "Revised" License
44 stars 19 forks source link

correct typo in multiple data block example #67

Closed huwjenkins closed 1 month ago

huwjenkins commented 1 month ago

The multiple data block example in the documentation mistakenly refers to an argument force_dict when this is always_dict:

https://github.com/teamtomo/starfile/blob/13d35c76d3a9e394fe8913ffc495aa56f745e56d/src/starfile/functions.py#L29-L30

https://github.com/teamtomo/starfile/blob/13d35c76d3a9e394fe8913ffc495aa56f745e56d/src/starfile/functions.py#L38-L39

codecov-commenter commented 1 month ago

:warning: Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 82.73%. Comparing base (5b19406) to head (97e069b). Report is 16 commits behind head on main.

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

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #67 +/- ## ========================================== + Coverage 80.93% 82.73% +1.80% ========================================== Files 7 7 Lines 278 307 +29 ========================================== + Hits 225 254 +29 Misses 53 53 ```

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

alisterburt commented 1 month ago

Great catch @huwjenkins - thank you for the PR!