improve meep docs

[joamatab]

• improve meep docs
• fix docstring return message for meep simulation

[sourcery-ai]

Sourcery Code Quality Report

Merging this PR leaves code quality unchanged.

Quality metrics	Before	After	Change
Complexity	28.86 😞	28.86 😞	0.00
Method Length	245.62 ⛔	245.62 ⛔	0.00
Working memory	6.38 🙂	6.38 🙂	0.00
Quality	26.80% 😞	26.80% 😞	0.00%

Other metrics	Before	After	Change
Lines	720	727	7

Changed files	Quality Before	Quality After	Quality Change
gdsfactory/simulation/gmeep/write_sparameters_meep.py	25.60% 😞	25.60% 😞	0.00%
gdsfactory/simulation/gmeep/write_sparameters_meep_batch.py	29.66% 😞	29.66% 😞	0.00%

Here are some functions in these files that still need a tune-up:

File	Function	Complexity	Length	Working Memory	Quality	Recommendation
gdsfactory/simulation/gmeep/write_sparameters_meep.py	write_sparameters_meep	47 ⛔	910 ⛔		5.64% ⛔	Refactor to reduce nesting. Try splitting into smaller methods
gdsfactory/simulation/gmeep/write_sparameters_meep_batch.py	write_sparameters_meep_batch	23 😞	365 ⛔	16 ⛔	22.67% ⛔	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
gdsfactory/simulation/gmeep/write_sparameters_meep.py	parse_port_eigenmode_coeff	6 ⭐	177 😞	13 😞	49.16% 😞	Try splitting into smaller methods. Extract out complex expressions

Legend and Explanation

The emojis denote the absolute quality of the code:

• ⭐ excellent
• 🙂 good
• 😞 poor
• ⛔ very poor

The 👍 and 👎 indicate whether the quality has improved or gotten worse with this pull request.

---

Please see our documentation here for details on how these metrics are calculated.

We are actively working on this report - lots more documentation and extra metrics to come!

Help us improve this quality report!

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication