search

balazsbotond / urlcat

A URL builder library for JavaScript.
https://urlcat.org
MIT License
1.82k stars 57 forks source link

Readme and JSDoc proofreading done #23

Closed praveen5959 closed 3 years ago

praveen5959 commented 3 years ago

Summary

READEME and JSDoc comments in the code have been proofread.

balazsbotond commented 3 years ago

Thank you for taking the time to proofread everything! Could you please also explain why you proposed each change?

praveen5959 commented 3 years ago

In the index.ts file, some JSDoc comments didna have appropriate fields like return value so I have added those. For some function, JSDoc comments were not present so I have added those as well.

In README file changes I have done to make the docs general and just first-person English. And small other changes here and there.

praveen5959 commented 3 years ago

Sure I will do it by today EOD.

balazsbotond commented 3 years ago

Sure I will do it by today EOD.

Thank you!

praveen5959 commented 3 years ago

I have updated the PR with the requested changes.

balazsbotond commented 3 years ago

Thank you! Merging 👍

balazsbotond commented 3 years ago

@all-contributors please add @praveen5959 for docs

allcontributors[bot] commented 3 years ago

@balazsbotond

I've put up a pull request to add @praveen5959! :tada: