HealthBioscienceIDEAS / microscopy-novice

https://healthbioscienceideas.github.io/microscopy-novice/
Other
1 stars 0 forks source link

Improve docstrings of all plotting files #51

Closed K-Meech closed 5 months ago

K-Meech commented 5 months ago

Closes https://github.com/HealthBioscienceIDEAS/microscopy-novice/issues/47

This PR improves the docstrings and comments on all plotting scripts from episodes/files

github-actions[bot] commented 5 months ago

Thank you!

Thank you for your pull request :smiley:

:robot: This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

Rendered Changes

:mag: Inspect the changes: https://github.com/HealthBioscienceIDEAS/microscopy-novice/compare/md-outputs..md-outputs-PR-51

The following changes were observed in the rendered markdown documents:

 .../QC_histogram_exercise.py                       |  28 ++++-
 .../image_with_noise.py                            |  28 ++++-
 .../snr_comparison.py                              |  34 +++++-
 .../filters_thresholding_plots/gaussian_kernels.py |  47 ++++++-
 .../brightness_comparison.py (new)                 | 135 +++++++++++++++++++++
 .../colormap_comparison.py (new)                   | 106 ++++++++++++++++
 .../histogram_exercise.py (new)                    | 123 +++++++++++++++++++
 7 files changed, 492 insertions(+), 9 deletions(-)
What does this mean? If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible. This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

:stopwatch: Updated at 2024-02-27 10:58:23 +0000