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
Merged

SDK Reference Documentation #53

merged 9 commits into from Jun 3, 2019

Conversation

sankethkatta
Copy link
Member

@sankethkatta sankethkatta 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 self-assigned this Jun 1, 2019
@codecov
Copy link

codecov bot 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.

Copy link
Contributor

@jerzzhang jerzzhang left a comment

Choose a reason for hiding this comment

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

grammar + spelling

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 Show resolved Hide resolved
@sankethkatta sankethkatta merged commit cc29c7b into master Jun 3, 2019
@sankethkatta sankethkatta deleted the error-documentation branch June 3, 2019 19:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants