search

pymeasure / pyleco

Python implementation of the Laboratory Experiment COntrol (LECO) protocol
MIT License
9 stars 3 forks source link

Improve documentation #80

Closed BenediktBurger closed 3 months ago

BenediktBurger commented 3 months ago

Address some issues from #40

codecov[bot] commented 3 months ago

Codecov Report

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

Project coverage is 87.59%. Comparing base (5235b4d) to head (9ebb869).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #80 +/- ## ======================================= Coverage 87.59% 87.59% ======================================= Files 36 36 Lines 2903 2903 Branches 355 355 ======================================= Hits 2543 2543 Misses 300 300 Partials 60 60 ``` | [Flag](https://app.codecov.io/gh/pymeasure/pyleco/pull/80/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pymeasure) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/pymeasure/pyleco/pull/80/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pymeasure) | `87.59% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pymeasure#carryforward-flags-in-the-pull-request-comment) to find out more.

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

BenediktBurger commented 3 months ago

I added (mermaid) flow charts to the GETTING_STARTED.md to make it easier to understand, how the different components work together.

The diagram information is only additional to the text, so if it does not render, it is only a small part of source code to skip. The readme links to the GETTING_STARTED.md on github, and github can render mermaid, which should work well.

What do you think, @bilderbuchi , @bklebel ?

bilderbuchi commented 3 months ago

I think it's no problem to add mermaid blocks.

bklebel commented 3 months ago

looks quite nice! :)

BenediktBurger commented 3 months ago

Thanks!