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

Add a docstring to Request.respond() #2409

Merged
merged 5 commits into from
Mar 14, 2022
Merged

Conversation

Bluenix2
Copy link
Contributor

Without a docstring this method will not show up in the Sphinx documentation.

See this relevant Discord conversation for information on how it was discovered.

Without a docstring this method will not show up in the Sphinx documentation.
@Bluenix2 Bluenix2 requested a review from a team as a code owner March 10, 2022 19:57
@codecov
Copy link

codecov bot commented Mar 10, 2022

Codecov Report

Merging #2409 (371284f) into main (7523e87) will increase coverage by 0.059%.
The diff coverage is n/a.

Impacted file tree graph

@@              Coverage Diff              @@
##              main     #2409       +/-   ##
=============================================
+ Coverage   87.110%   87.170%   +0.059%     
=============================================
  Files           60        60               
  Lines         5004      5004               
  Branches       905       905               
=============================================
+ Hits          4359      4362        +3     
+ Misses         472       470        -2     
+ Partials       173       172        -1     
Impacted Files Coverage Δ
sanic/request.py 96.187% <ø> (ø)
sanic/server/protocols/http_protocol.py 88.095% <0.000%> (+3.571%) ⬆️

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 7523e87...371284f. Read the comment docs.

Co-authored-by: Ryu juheon <[email protected]>
ahopkins
ahopkins previously approved these changes Mar 11, 2022
@Bluenix2
Copy link
Contributor Author

Bluenix2 commented Mar 11, 2022

I originally did so, BaseHTTPResponse more specifically because it would match the parameter, but it failed type checks as seen here.

I could not figure out how or why it failed so I reverted that change. It did not fix the seemingly unrelated test failure though.

@Bluenix2 Bluenix2 requested a review from a team as a code owner March 13, 2022 09:26
@ahopkins
Copy link
Member

I originally did so, BaseHTTPResponse more specifically because it would match the parameter, but it failed type checks as seen here.

I could not figure out how or why it failed so I reverted that change. It did not fix the seemingly unrelated test failure though.

I made a couple of changes. We can worry about the type annotation issue another time.

sanic/request.py Outdated Show resolved Hide resolved
Copy link
Member

@ahopkins ahopkins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great change. I'll deal with the flaky tests 🤬

@ahopkins ahopkins merged commit 0c9df02 into sanic-org:main Mar 14, 2022
ChihweiLHBird pushed a commit to ChihweiLHBird/sanic that referenced this pull request Jun 1, 2022
Co-authored-by: Ryu juheon <[email protected]>
Co-authored-by: Adam Hopkins <[email protected]>
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.

3 participants