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

Fix code example in docs #4313

Merged
merged 4 commits into from
Nov 1, 2019
Merged

Fix code example in docs #4313

merged 4 commits into from
Nov 1, 2019

Conversation

vickz84259
Copy link
Contributor

@vickz84259 vickz84259 commented Oct 31, 2019

What do these changes do?

Fix a typo in an example on the page about Multipart . The example referenced a non-existent function. After fixing the typo the code still didn't run as intended. This fixes that too.

Are there changes in behavior for the user?

A working example.

Related issue number

#4312
#4314

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."

Fix an typo in an example. The example referenced a non-existent function.
@codecov-io
Copy link

codecov-io commented Oct 31, 2019

Codecov Report

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

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #4313   +/-   ##
=======================================
  Coverage   97.55%   97.55%           
=======================================
  Files          43       43           
  Lines        8862     8862           
  Branches     1389     1389           
=======================================
  Hits         8645     8645           
  Misses         93       93           
  Partials      124      124

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 ea05cd9...ffa4774. Read the comment docs.

@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Oct 31, 2019
The `MultipartWriter.write` function was not being awaited hence the post
function would get called before data is written to the buffer.
@vickz84259 vickz84259 changed the title Fix #4312 typo in multipart docs Fix code example in docs Nov 1, 2019
@asvetlov asvetlov merged commit 419c33c into aio-libs:master Nov 1, 2019
@asvetlov
Copy link
Member

asvetlov commented Nov 1, 2019

thanks!

asvetlov pushed a commit that referenced this pull request Nov 1, 2019
(cherry picked from commit 419c33c)

Co-authored-by: Victor Otieno <vickz84259@gmail.com>
asvetlov added a commit that referenced this pull request Nov 1, 2019
(cherry picked from commit 419c33c)

Co-authored-by: Victor Otieno <vickz84259@gmail.com>
@vickz84259 vickz84259 deleted the patch-1 branch November 3, 2019 21:20
asvetlov pushed a commit that referenced this pull request Oct 16, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bot:chronographer:provided There is a change note present in this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants