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

Improve documentation quality #7

Open
suryapratapsinghsuryavanshi opened this issue Oct 2, 2021 · 11 comments · Fixed by #5, #6, #9, #15 or #17
Open

Improve documentation quality #7

suryapratapsinghsuryavanshi opened this issue Oct 2, 2021 · 11 comments · Fixed by #5, #6, #9, #15 or #17
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers hacktoberfest

Comments

@suryapratapsinghsuryavanshi
Copy link
Owner

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 🙌.

@suryapratapsinghsuryavanshi suryapratapsinghsuryavanshi added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers hacktoberfest labels Oct 2, 2021
This was linked to pull requests Oct 3, 2021
@suryapratapsinghsuryavanshi suryapratapsinghsuryavanshi linked a pull request Oct 7, 2021 that will close this issue
@robakerson
Copy link
Contributor

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

@suryapratapsinghsuryavanshi
Copy link
Owner Author

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.

@suryapratapsinghsuryavanshi suryapratapsinghsuryavanshi linked a pull request Oct 11, 2021 that will close this issue
@robakerson
Copy link
Contributor

#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

@suryapratapsinghsuryavanshi
Copy link
Owner Author

#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.

@suryapratapsinghsuryavanshi suryapratapsinghsuryavanshi linked a pull request Oct 11, 2021 that will close this issue
@robakerson
Copy link
Contributor

#19 Will keep looking when merged :)

@suryapratapsinghsuryavanshi suryapratapsinghsuryavanshi linked a pull request Oct 12, 2021 that will close this issue
@robakerson
Copy link
Contributor

#20 big chunk :)

@suryapratapsinghsuryavanshi
Copy link
Owner Author

#20 big chunk :)

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

@suryapratapsinghsuryavanshi suryapratapsinghsuryavanshi linked a pull request Oct 14, 2021 that will close this issue
@CodingAce123
Copy link
Contributor

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!

@suryapratapsinghsuryavanshi
Copy link
Owner Author

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.

@martin-badin
Copy link

martin-badin commented Dec 5, 2021

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));

@suryapratapsinghsuryavanshi
Copy link
Owner Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment