This repository has been archived by the owner on Dec 1, 2023. It is now read-only.
adds description and example for all the library methods and updates documentation in Readme file #11
+202
−33
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…Readme file with the same documentation.
|
@all-contributors please add @Badrri-Narayanan for doc |
|
I've put up a pull request to add @Badrri-Narayanan! 🎉 |
|
Thanks for the contribution! You'v done a nice work. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adds description and examples for all the library methods and also adds the same description and examples to the README file.
Issue ticket number and link
closes #10
Other stuff
After adding the description and examples, I ran the test suite and I observed the there was no breaking changes. Add the console logs below for reference.
Kindly let me know your review comments. Thanks!