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

SDK Reference Documentation #53

Merged
merged 9 commits into from Jun 3, 2019

Conversation

2 participants
@sankethkatta
Copy link
Member

commented Jun 1, 2019

This PR started to address #52 which pointed out the lack of documentation around errors returned to the completion handler in the SDK. The PR expanded to re-format the documentation into a nicer tabular format and split the class and method reference into a separate file which is easier to read and navigate.

It is best reviewed by looking at the READMEs in the rendered view:

@sankethkatta sankethkatta requested review from jerzzhang and allisonc07 Jun 1, 2019

@sankethkatta sankethkatta self-assigned this Jun 1, 2019

@codecov

This comment has been minimized.

Copy link

commented Jun 1, 2019

Codecov Report

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

Impacted file tree graph

@@          Coverage Diff          @@
##           master    #53   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files           2      2           
  Lines          64     64           
=====================================
  Hits           64     64

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 a1c759f...1830472. Read the comment docs.

@jerzzhang
Copy link
Contributor

left a comment

grammar + spelling

Show resolved Hide resolved doc/README.md Outdated
Show resolved Hide resolved doc/README.md Outdated
Show resolved Hide resolved doc/README.md Outdated
Show resolved Hide resolved README.md Outdated

@sankethkatta sankethkatta requested a review from jerzzhang Jun 3, 2019

@sankethkatta sankethkatta merged commit cc29c7b into master Jun 3, 2019

4 checks passed

Travis CI - Branch Build Passed
Details
Travis CI - Pull Request Build Passed
Details
codecov/patch Coverage not affected when comparing a1c759f...1830472
Details
codecov/project 100% remains the same compared to a1c759f
Details

@sankethkatta sankethkatta deleted the error-documentation branch Jun 3, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.