alexfertel
Add documentation
We want to document each class of algorithms. This comes in two flavors:
- Adding README files to each directory holding a class of algorithms, for example,
sorting. - Adding documentation comments to each of the algorithms.
You can find examples of documentation comments here.
General guidelines for the explanations are:
- Be concise. Keep in mind these algorithms are meant for educational purposes.
- Link to the bibliography.
- Images are better than no images.
- If it is possible, include time and space complexities.
Do you still need help for the documentation of the algorithms?
Yes, we do! You can just choose whatever algo you want and document it the best you can.
As I see many folders (string, sorting for example) have already had README file in their directory. Are they good or we still able to revise and improve them?
As I see many folders (string, sorting for example) have already had README file in their directory. Are they good or we still able to revise and improve them?
Yes! Please feel free to submit improvements wherever you may see fit! @tvcapital
Is there still any help needed?
Yes! Feel free to open PRs adding docs wherever you may see fit! 👍🏻 @patilniraj8
Ok I would like to work on it thanks
On Fri, 11 Aug, 2023, 1:17 pm Alexander González, @.***> wrote:
Is there still any help needed?
Yes! Feel free to open PRs adding docs wherever you may see fit! 👍🏻 @patilniraj8 https://github.com/patilniraj8
— Reply to this email directly, view it on GitHub https://github.com/alexfertel/rust-algorithms/issues/8#issuecomment-1674338710, or unsubscribe https://github.com/notifications/unsubscribe-auth/A2G36VTCWOAAARABCA2Z5VTXUXPPXANCNFSM475L2YUQ . You are receiving this because you were mentioned.Message ID: @.***>
I have written up ReadMe.md's for the General and Graphs folders. Tomorrow I plan to write one for the Math's folder and submit a PR.
Worked on the readme.md for bit manipulation. Can you review my PR #72 in addition of I made some changes for readability.
