Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add more sax models #364

Merged
merged 4 commits into from
Mar 24, 2024
Merged

add more sax models #364

merged 4 commits into from
Mar 24, 2024

Conversation

joamatab
Copy link
Contributor

  • mmi
  • crossing

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @joamatab - I've reviewed your changes and they look great!

General suggestions:

  • Consider adding input validation for the new MMI models to ensure parameters are within physically plausible limits.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Docstrings: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

Comment on lines +325 to +327
def mmi1x2(
wl: Float = 1.55, wl0: Float = 1.55, fwhm: Float = 0.2, loss_dB: Float = 0.3
) -> sax.SDict:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion (code_refinement): Consider validating input parameters for mmi1x2.

Given the physical nature of the parameters, it might be beneficial to validate their ranges to ensure they are within physically plausible limits.

@joamatab joamatab added the enhancement New feature or request label Mar 24, 2024
@joamatab joamatab merged commit 45f2250 into main Mar 24, 2024
13 checks passed
@joamatab joamatab deleted the more_models branch March 24, 2024 17:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant