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

Updated ReadMe.MD to have better commenting on the usage. #14

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

cahilltr
Copy link

Added comments to the usage examples to help a user understand what each function does. Figuring this out took me a little longer than it should have (due to my unfamiliarity with JavaScript conventions and it being early for me).

The first comment describes what the stringify() produces.
//Creates a String like '(name'John*20Doeage42children('Mary'Bill))'
str = JSURL.stringify(obj);

The second comment describes what the parse() produces.
//Creates an Object like '{"name":"John Doe","age":42,"children":["Mary","Bill"]}'
obj = JSURL.parse(str);

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.

1 participant