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

API Docs & Annotations #2006

Merged
merged 22 commits into from
Feb 28, 2021
Merged

API Docs & Annotations #2006

merged 22 commits into from
Feb 28, 2021

Conversation

ahopkins
Copy link
Member

@ahopkins ahopkins commented Jan 18, 2021

Alongside the release of the new user guide, this is a removal of all the documentation we no longer need. It also goes through and adds missing type annotations and docstrings.

Requires #2010 to be merged.

Freshen up the look just a little with logo and removing the blue.

image

@ahopkins ahopkins marked this pull request as draft January 18, 2021 20:13
@codecov
Copy link

codecov bot commented Jan 18, 2021

Codecov Report

Merging #2006 (161efc6) into master (dbfc11f) will decrease coverage by 0.351%.
The diff coverage is 91.216%.

Impacted file tree graph

@@              Coverage Diff              @@
##            master     #2006       +/-   ##
=============================================
- Coverage   92.070%   91.719%   -0.351%     
=============================================
  Files           33        35        +2     
  Lines         3102      3200       +98     
  Branches       542       555       +13     
=============================================
+ Hits          2856      2935       +79     
- Misses         166       181       +15     
- Partials        80        84        +4     
Impacted Files Coverage Δ
sanic/config.py 100.000% <ø> (ø)
sanic/headers.py 100.000% <ø> (ø)
sanic/mixins/middleware.py 100.000% <ø> (ø)
sanic/views.py 97.674% <ø> (ø)
sanic/models/protocol_types.py 71.429% <71.429%> (ø)
sanic/http.py 77.778% <85.714%> (-0.335%) ⬇️
sanic/request.py 97.842% <89.130%> (-1.412%) ⬇️
sanic/app.py 91.721% <89.655%> (-0.243%) ⬇️
sanic/server.py 87.671% <92.593%> (-0.284%) ⬇️
sanic/models/asgi.py 93.443% <93.443%> (ø)
... and 18 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update dbfc11f...161efc6. Read the comment docs.

@yunstanford
Copy link
Member

👍 cool

@ahopkins ahopkins added this to the v21.3 milestone Jan 28, 2021
@ahopkins ahopkins mentioned this pull request Feb 17, 2021
@ahopkins ahopkins marked this pull request as ready for review February 17, 2021 13:56
@ahopkins ahopkins merged commit eef44ae into master Feb 28, 2021
@ahopkins ahopkins deleted the docs-annotations branch February 28, 2021 17:59
@ahopkins ahopkins mentioned this pull request May 31, 2021
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.

2 participants