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

Clarify WebSocket quickstart example #3559

Merged
merged 3 commits into from
Jan 21, 2019
Merged

Conversation

ncoghlan
Copy link
Contributor

@ncoghlan ncoghlan commented Jan 21, 2019

What do these changes do?

I initially thought this example was missing some "break"
calls before realising that WebSocketResponse would be
taking care of the loop termination internally.

I suspect I may not be the only person to make that
mistake, so this proposes an inline comment in the
example pointing out what is actually going on.

Are there changes in behavior for the user?

No

Related issue number

N/A

Checklist

  • [-] I think the code is well written
  • [-] Unit tests for the changes exist
  • Documentation reflects the changes
  • [-] If you provide code modification, please add yourself to CONTRIBUTORS.txt
    • The format is <Name> <Surname>.
    • Please keep alphabetical order, the file is sorted by names.
  • Add a new news fragment into the CHANGES folder
    • name it <issue_id>.<type> for example (588.bugfix)
    • if you don't have an issue_id change it to the pr id after creating the pr
    • ensure type is one of the following:
      • .feature: Signifying a new feature.
      • .bugfix: Signifying a bug fix.
      • .doc: Signifying a documentation improvement.
      • .removal: Signifying a deprecation or removal of public API.
      • .misc: A ticket has been closed, but it is not of interest to users.
    • Make sure to use full sentences with correct case and punctuation, for example: "Fix issue with non-ascii contents in doctest text files."

I initially thought this example was missing some "break"
calls before realising that WebSocketResponse would be
taking care of the loop termination internally.
@codecov-io
Copy link

Codecov Report

Merging #3559 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #3559   +/-   ##
=======================================
  Coverage   97.91%   97.91%           
=======================================
  Files          43       43           
  Lines        8577     8577           
  Branches     1384     1384           
=======================================
  Hits         8398     8398           
  Misses         74       74           
  Partials      105      105

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 94e7b49...3f72d3f. Read the comment docs.

@asvetlov asvetlov merged commit 167918e into aio-libs:master Jan 21, 2019
@asvetlov
Copy link
Member

thanks, @ncoghlan

@lock lock bot added the outdated label Jan 22, 2020
@lock lock bot locked as resolved and limited conversation to collaborators Jan 22, 2020
@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Jan 22, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bot:chronographer:provided There is a change note present in this PR outdated
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants