Skip to content

Add examples to all docstrings and update notebooks#214

Merged
henrikjacobsenfys merged 4 commits into
developfrom
add-docstring-examples
Jun 23, 2026
Merged

Add examples to all docstrings and update notebooks#214
henrikjacobsenfys merged 4 commits into
developfrom
add-docstring-examples

Conversation

@henrikjacobsenfys

Copy link
Copy Markdown
Member

No description provided.

@henrikjacobsenfys henrikjacobsenfys added [scope] documentation Documentation only changes (major.minor.patch.POST) [priority] medium Normal/default priority labels Jun 22, 2026
@codecov

codecov Bot commented Jun 22, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 73.33333% with 4 lines in your changes missing coverage. Please review.
✅ Project coverage is 97.89%. Comparing base (0a0bf47) to head (27037ad).

Files with missing lines Patch % Lines
src/easydynamics/analysis/analysis.py 50.00% 1 Missing ⚠️
src/easydynamics/analysis/analysis1d.py 50.00% 1 Missing ⚠️
...easydynamics/convolution/analytical_convolution.py 50.00% 1 Missing ⚠️
.../easydynamics/convolution/numerical_convolution.py 50.00% 1 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##           develop     #214      +/-   ##
===========================================
- Coverage    97.99%   97.89%   -0.11%     
===========================================
  Files           52       52              
  Lines         3639     3653      +14     
  Branches       650      650              
===========================================
+ Hits          3566     3576      +10     
- Misses          41       45       +4     
  Partials        32       32              
Flag Coverage Δ
unittests 97.89% <73.33%> (-0.11%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
src/easydynamics/analysis/analysis_base.py 100.00% <ø> (ø)
src/easydynamics/analysis/fit_binding.py 94.87% <ø> (ø)
src/easydynamics/analysis/parameter_analysis.py 98.37% <ø> (ø)
src/easydynamics/convolution/convolution.py 100.00% <100.00%> (ø)
...dynamics/convolution/numerical_convolution_base.py 97.36% <ø> (ø)
src/easydynamics/experiment/experiment.py 97.66% <ø> (ø)
src/easydynamics/sample_model/background_model.py 100.00% <100.00%> (ø)
.../easydynamics/sample_model/component_collection.py 99.13% <ø> (ø)
...ple_model/components/damped_harmonic_oscillator.py 100.00% <ø> (ø)
...dynamics/sample_model/components/delta_function.py 92.15% <ø> (ø)
... and 23 more
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@henrikjacobsenfys henrikjacobsenfys merged commit ee07ccf into develop Jun 23, 2026
34 of 35 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[priority] medium Normal/default priority [scope] documentation Documentation only changes (major.minor.patch.POST)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant