solverjs icon indicating copy to clipboard operation
solverjs copied to clipboard

Improve documentation quality

Open suryapratapsinghsuryavanshi opened this issue 4 years ago • 11 comments

There are many methods included in this project, but the biggest problem for the user is that we have given less information about the methods, if you are interested in adding more documents about the methods, please contribute yours 🙌.

I have tried to do a PR for this #17 :). Let me know if this is OK and I will make more!

robakerson avatar Oct 11 '21 05:10 robakerson

I have tried to do a PR for this #17 :). Let me know if this is OK and I will make more!

Yeah, it's good. Contribute more to this.

#18 more :).

Will look at more tomorrow if 18 is merged!

Can you tell me where alternativeStringArrange method comes from? I think there are 2 typos on that description but I don't understand the purpose of the method to know if I am misreading it.

Thank you

robakerson avatar Oct 11 '21 06:10 robakerson

#18 more :).

Will look at more tomorrow if 18 is merged!

Can you tell me where alternativeStringArrange method comes from? I think there are 2 typos on that description but I don't understand the purpose of the method to know if I am misreading it.

Thank you

alternativeStringArrange method arranges two strings in an alternate way like the first string is 'abc' and the second is 'pqr' then this method 'apbqcr' will return the string something like this.

#19 Will keep looking when merged :)

robakerson avatar Oct 12 '21 02:10 robakerson

#20 big chunk :)

robakerson avatar Oct 12 '21 07:10 robakerson

#20 big chunk :)

Wait for It, I will convert your Chunk to Data :)

There are many methods included in this project, but the biggest problem for the user is that we have given less information about the methods, if you are interested in adding more documents about the methods, please contribute yours 🙌.

I Have Edited Contributing.md and Added Badges For Your README, Also Changed The Document Format..... I Have Opened a Pull Request, @suryapratapsinghsuryavanshi So, Please Check My Pull Request and Approve it soon! Till Then, Happy Hacktoberfest!

CodingAce123 avatar Oct 14 '21 10:10 CodingAce123

There are many methods included in this project, but the biggest problem for the user is that we have given less information about the methods, if you are interested in adding more documents about the methods, please contribute yours 🙌.

I Have Edited Contributing.md and Added Badges For Your README, Also Changed The Document Format..... I Have Opened a Pull Request, @suryapratapsinghsuryavanshi So, Please Check My Pull Request and Approve it soon! Till Then, Happy Hacktoberfest!

Yes, I will merge your PR Please make the requested changes.

Hi guys. I found a few issues in the documentation.

First one https://github.com/suryapratapsinghsuryavanshi/solverjs/blob/main/README.md#terabyte-to-gigabyte--tbtotbtb it should be console.log(solverjs.tbToGb(1))

Second one https://github.com/suryapratapsinghsuryavanshi/solverjs/blob/main/README.md#sumalldigit it should be console.log(solverjs.sumAllDigit(123));

martin-badin avatar Dec 05 '21 12:12 martin-badin

Hi guys. I found a few issues in the documentation.

First one https://github.com/suryapratapsinghsuryavanshi/solverjs/blob/main/README.md#terabyte-to-gigabyte--tbtotbtb it should be console.log(solverjs.tbToGb(1))

Second one https://github.com/suryapratapsinghsuryavanshi/solverjs/blob/main/README.md#sumalldigit it should be console.log(solverjs.sumAllDigit(123));

thanks @martin-badin!, I will fix it soon.