NanoComp / meep

free finite-difference time-domain (FDTD) software for electromagnetic simulations
GNU General Public License v2.0
1.19k stars 610 forks source link

add docstrings to adjoint solver #2556

Closed mochen4 closed 1 year ago

mochen4 commented 1 year ago

Add docstrings to objective.py and optimization_problem.py

codecov-commenter commented 1 year ago

Codecov Report

Merging #2556 (499c8f8) into master (37516cf) will decrease coverage by 0.01%. The diff coverage is 100.00%.

:exclamation: Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

@@            Coverage Diff             @@
##           master    #2556      +/-   ##
==========================================
- Coverage   73.91%   73.90%   -0.01%     
==========================================
  Files          18       18              
  Lines        5294     5293       -1     
==========================================
- Hits         3913     3912       -1     
  Misses       1381     1381              
Impacted Files Coverage Δ
python/adjoint/optimization_problem.py 59.48% <ø> (ø)
python/adjoint/objective.py 92.38% <100.00%> (-0.04%) :arrow_down:

... and 2 files with indirect coverage changes