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

use jupyterbook for docs #203

Merged
merged 6 commits into from
Mar 3, 2023
Merged

use jupyterbook for docs #203

merged 6 commits into from
Mar 3, 2023

Conversation

joamatab
Copy link
Contributor

@joamatab joamatab commented Mar 3, 2023

  • use jupyterbook for docs
  • use py notebooks instead of ipynb
  • update to latest gdsfactory

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Mar 3, 2023

Sourcery Code Quality Report

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

Quality metrics Before After Change
Complexity 4.48 ⭐ 4.56 ⭐ 0.08 👎
Method Length 155.74 😞 154.27 😞 -1.47 👍
Working memory 14.05 😞 15.01 😞 0.96 👎
Quality 52.03% 🙂 50.28% 🙂 -1.75% 👎
Other metrics Before After Change
Lines 798 697 -101
Changed files Quality Before Quality After Quality Change
install_tech.py 68.07% 🙂 77.41% ⭐ 9.34% 👍
ubcpdk/__init__.py 51.58% 🙂 51.66% 🙂 0.08% 👍
ubcpdk/samples/test_masks.py 82.24% ⭐ 80.54% ⭐ -1.70% 👎
ubcpdk/samples/ubc_simon.py 45.31% 😞 45.31% 😞 0.00%

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

File Function Complexity Length Working Memory Quality Recommendation
ubcpdk/samples/ubc_simon.py crosstalk_experiment_parametrized_mask 11 🙂 990 ⛔ 24 ⛔ 24.96% ⛔ Try splitting into smaller methods. Extract out complex expressions
ubcpdk/samples/ubc_simon.py ring_single_heater 0 ⭐ 385 ⛔ 25 ⛔ 36.78% 😞 Try splitting into smaller methods. Extract out complex expressions
ubcpdk/samples/ubc_simon.py resonator_proximity_io 6 ⭐ 322 ⛔ 16 ⛔ 37.62% 😞 Try splitting into smaller methods. Extract out complex expressions
ubcpdk/samples/ubc_simon.py disks_proximity 4 ⭐ 196 😞 11 😞 52.84% 🙂 Try splitting into smaller methods. Extract out complex expressions
ubcpdk/samples/ubc_simon.py rings_proximity 4 ⭐ 179 😞 11 😞 54.24% 🙂 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!

@codecov
Copy link

codecov bot commented Mar 3, 2023

Codecov Report

Merging #203 (dcbe132) into main (7349099) will not change coverage.
The diff coverage is 0.00%.

❗ Current head dcbe132 differs from pull request most recent head 64066a9. Consider uploading reports for the commit 64066a9 to get more accurate results

@@           Coverage Diff           @@
##             main     #203   +/-   ##
=======================================
  Coverage   46.51%   46.51%           
=======================================
  Files          23       23           
  Lines        1163     1163           
=======================================
  Hits          541      541           
  Misses        622      622           
Impacted Files Coverage Δ
ubcpdk/__init__.py 90.47% <ø> (ø)
ubcpdk/samples/ubc_simon.py 0.00% <0.00%> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@joamatab joamatab merged commit f6def16 into main Mar 3, 2023
@joamatab joamatab deleted the 121 branch March 3, 2023 02:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant