5612

[joamatab]

• improve some types and docs

[sourcery-ai]

Sourcery Code Quality Report

❌  Merging this PR will decrease code quality in the affected files by 0.02%.

Quality metrics	Before	After	Change
Complexity	4.74 ⭐	4.71 ⭐	-0.03 👍
Method Length	95.57 🙂	96.07 🙂	0.50 👎
Working memory	16.67 ⛔	16.62 ⛔	-0.05 👍
Quality	51.34% 🙂	51.32% 🙂	-0.02% 👎

Other metrics	Before	After	Change
Lines	956	958	2

Changed files	Quality Before	Quality After	Quality Change
gdsfactory/add_grating_couplers.py	30.34% 😞	30.34% 😞	0.00%
gdsfactory/types.py	65.28% 🙂	64.96% 🙂	-0.32% 👎
gdsfactory/simulation/gtidy3d/modes.py	63.10% 🙂	63.10% 🙂	0.00%

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

File	Function	Complexity	Length	Working Memory	Quality	Recommendation
gdsfactory/add_grating_couplers.py	add_grating_couplers_with_loopback_fiber_array	16 🙂	476 ⛔	34 ⛔	19.55% ⛔	Try splitting into smaller methods. Extract out complex expressions
gdsfactory/add_grating_couplers.py	add_grating_couplers_with_loopback_fiber_single	9 🙂	393 ⛔	26 ⛔	27.60% 😞	Try splitting into smaller methods. Extract out complex expressions
gdsfactory/simulation/gtidy3d/modes.py	Waveguide.compute_modes	2 ⭐	260 ⛔	33 ⛔	36.94% 😞	Try splitting into smaller methods. Extract out complex expressions
gdsfactory/simulation/gtidy3d/modes.py	plot	6 ⭐	146 😞	16 ⛔	48.42% 😞	Try splitting into smaller methods. Extract out complex expressions
gdsfactory/simulation/gtidy3d/modes.py	sweep_bend_loss	1 ⭐	152 😞	14 😞	55.10% 🙂	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