Issue#1208

[lisphilar]

Related issues

#1208

What was changed

• close [Docs] improve readability of API reference by updating titles and ignore internal classes #1208

[sourcery-ai]

Sourcery Code Quality Report

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

Quality metrics	Before	After	Change
Complexity	1.03 ⭐	2.60 ⭐	1.57 👎
Method Length	79.10 🙂	80.50 🙂	1.40 👎
Working memory	7.06 🙂	8.00 🙂	0.94 👎
Quality	71.06% 🙂	69.06% 🙂	-2.00% 👎

Other metrics	Before	After	Change
Lines	673	106	-567

Changed files	Quality Before	Quality After	Quality Change
covsirphy/downloading/downloader.py	69.06% 🙂	69.06% 🙂	0.00%

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

File	Function	Complexity	Length	Working Memory	Quality	Recommendation
covsirphy/downloading/downloader.py	DataDownloader.layer	4 ⭐	147 😞	9 🙂	61.32% 🙂	Try splitting into smaller methods

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]

Codecov Report

Merging #1209 (a1f1580) into master (03ee421) will decrease coverage by 0.14%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master    #1209      +/-   ##
==========================================
- Coverage   84.27%   84.12%   -0.15%     
==========================================
  Files          46       46              
  Lines        3357     3357              
==========================================
- Hits         2829     2824       -5     
- Misses        528      533       +5     

Impacted Files	Coverage Δ
covsirphy/downloading/_provider.py	100.00% <ø> (ø)
covsirphy/downloading/_db.py	89.65% <100.00%> (ø)
covsirphy/downloading/_db_covid19dh.py	93.54% <100.00%> (ø)
covsirphy/downloading/_db_cs_japan.py	100.00% <100.00%> (ø)
covsirphy/downloading/_db_google.py	98.38% <100.00%> (ø)
covsirphy/downloading/_db_owid.py	100.00% <100.00%> (ø)
covsirphy/downloading/downloader.py	100.00% <100.00%> (ø)
covsirphy/science/ode_scenario.py	67.22% <0.00%> (-2.11%)	⬇️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.