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

Flesh out Quick Start examples #654

Merged
merged 1 commit into from
Jul 2, 2019
Merged

Conversation

mbidewell
Copy link

@mbidewell mbidewell commented Jul 1, 2019

Description

Update documentation to improve clarity of Blocking and Asynchronous Examples

Type of change

Check all that apply

  • Bug fix (a non-breaking change which fixes an issue)
  • New feature (a non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Refactoring (a change which changes the current internal or external interface)
  • This change requires a documentation update

How Has This Been Tested?

This fix is for documentation changes

Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation, if necessary
  • My changes generate no new compiler warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Inspect the bytecode viewer, including reasoning why

@codecov
Copy link

codecov bot commented Jul 1, 2019

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff            @@
##             master     #654   +/-   ##
=========================================
  Coverage     71.07%   71.07%           
  Complexity      297      297           
=========================================
  Files            57       57           
  Lines          1490     1490           
  Branches        193      193           
=========================================
  Hits           1059     1059           
  Misses          339      339           
  Partials         92       92

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 ae63fb0...fef2e12. Read the comment docs.

README.md Show resolved Hide resolved
@kittinunf
Copy link
Owner

Overall this is great! Thanks so much for updating the documentation for us!!!

@SleeplessByte SleeplessByte added the 📖 documentation Documentation changes label Jul 1, 2019
@kittinunf kittinunf merged commit 58ac08b into kittinunf:master Jul 2, 2019
@kittinunf kittinunf mentioned this pull request Jul 22, 2019
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 documentation Documentation changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants