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.

Sign up for GitHub

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

Jump to bottom

feat: refine docs and error messages #27

Merged
merged 5 commits into from
May 2, 2023
Merged

feat: refine docs and error messages #27

merged 5 commits into from
May 2, 2023

Conversation

mantariksh
Copy link
Contributor

Before publishing multiple SDKs, we should set up this one as an example. This PR does the following

  1. Refines and adds detail to documentation for each function
  2. Extracts all error messages into a separate file, so it is easy for other SDKs to reference and ensure the error messages are consistent
  3. Refines error messages to be clearer and (wherever possible) more actionable

LoneRifle
LoneRifle approved these changes Apr 13, 2023
View reviewed changes
Copy link
Contributor

@LoneRifle LoneRifle left a comment

Choose a reason for hiding this comment

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

lgtm

@mantariksh mantariksh requested a review from kwajiehao April 25, 2023 03:04
kwajiehao
kwajiehao approved these changes Apr 28, 2023
View reviewed changes
Copy link
Contributor

@kwajiehao kwajiehao left a comment

Choose a reason for hiding this comment

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

lgtm

@kwajiehao kwajiehao mentioned this pull request Apr 28, 2023
Closed
@mantariksh mantariksh merged commit c7dcf95 into develop May 2, 2023
@mantariksh mantariksh deleted the feat/refinements branch May 2, 2023 08:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kwajiehao kwajiehao kwajiehao approved these changes

@LoneRifle LoneRifle LoneRifle approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@mantariksh @LoneRifle @kwajiehao