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

Rename plot flags in plot2D and add deprecation warning #2885

Merged
merged 1 commit into from
Aug 22, 2024

Conversation

oskooi
Copy link
Collaborator

@oskooi oskooi commented Aug 16, 2024

Renames the keyword parameters plot_eps_flag, plot_sources_flag, plot_monitors_flag, and plot_boundaries_flag of plot2D to show_epsilon, show_sources, show_monitors, and show_boundary_layers, respectively. Also adds a deprecation warning. This renaming is intended to improve readability.

@codecov-commenter
Copy link

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

Attention: Patch coverage is 60.00000% with 8 lines in your changes missing coverage. Please review.

Project coverage is 73.71%. Comparing base (f29a8c7) to head (373bd41).
Report is 30 commits behind head on master.

Files Patch % Lines
python/visualization.py 60.00% 8 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2885      +/-   ##
==========================================
- Coverage   73.81%   73.71%   -0.11%     
==========================================
  Files          18       18              
  Lines        5423     5444      +21     
==========================================
+ Hits         4003     4013      +10     
- Misses       1420     1431      +11     
Files Coverage Δ
python/simulation.py 77.41% <ø> (ø)
python/visualization.py 37.31% <60.00%> (+0.28%) ⬆️

Copy link
Collaborator

@smartalecH smartalecH left a comment

Choose a reason for hiding this comment

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

LGTM!

@stevengj stevengj merged commit aed9c6a into NanoComp:master Aug 22, 2024
5 checks passed
@oskooi oskooi deleted the plot2D_rename_plot_flags branch August 22, 2024 19:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants