Lossless

[djps]

Fixes missing lossless option #657

Summary by CodeRabbit

• Bug Fixes
  • Corrected spelling in equation of state output from "loseless" to "lossless".
  • Improved handling for lossless equation of state scenarios.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

A typo in the equation of state return value is corrected from "loseless" to "lossless", and corresponding handling for the lossless case is added to the absorption variables creation function.

Changes

Cohort / File(s)	Summary
Equation of State Typo Correction kwave/kWaveSimulation.py	Fixed typo in string returned by equation_of_state: "loseless" → "lossless"
Absorption Variables Handler kwave/kWaveSimulation_helper/create_absorption_variables.py	Added conditional branch to return (None, None, None, None) when equation_of_state is "lossless"

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

A typo hops away with glee,
"Lossless" now spelled perfectly!
When absorption's none to find,
Four Nones return, by design. 🐰✨

🚥 Pre-merge checks | ✅ 1 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 66.67% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.
Title check	❓ Inconclusive	The title 'Lossless' is vague and generic, using a single word that doesn't clearly convey what changed or why, making it difficult for reviewers to understand the specific nature of the fix without reading the full description.	Use a more descriptive title such as 'Fix typo: change loseless to lossless' or 'Add support for lossless equation of state option' to clarify the specific change being made.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Docstrings were successfully generated.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[codecov]

Codecov Report

❌ Patch coverage is 0% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 73.93%. Comparing base (6ec3d6d) to head (1720489).
⚠️ Report is 3 commits behind head on master.

Files with missing lines	Patch %	Lines
...veSimulation_helper/create_absorption_variables.py	0.00%	2 Missing ⚠️
kwave/kWaveSimulation.py	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #658      +/-   ##
==========================================
- Coverage   73.95%   73.93%   -0.03%     
==========================================
  Files          50       50              
  Lines        7000     7002       +2     
  Branches     1338     1339       +1     
==========================================
  Hits         5177     5177              
- Misses       1280     1282       +2     
  Partials      543      543              

Flag	Coverage Δ
3.10	73.93% <0.00%> (-0.03%)	⬇️
3.11	73.93% <0.00%> (-0.03%)	⬇️
3.12	73.93% <0.00%> (-0.03%)	⬇️
3.13	73.93% <0.00%> (-0.03%)	⬇️
macos-latest	73.90% <0.00%> (-0.03%)	⬇️
ubuntu-latest	73.90% <0.00%> (-0.03%)	⬇️
windows-latest	73.92% <0.00%> (-0.03%)	⬇️

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[coderabbitai]

Note

Docstrings generation - SUCCESS
Generated docstrings for this pull request at #659