Documentation #62
Documentation #62
Conversation
This is an initial commit, further improvement will be added soon
|
Documentation for a broad topic, such as sorting, searching, backtracking etc. is unnecessary as it would only have a general introduction, which can be found elsewhere, and contents - which are good to have but already exist in the Wiki. |
|
The problem with maintaining such a repo is that we need to put a starting point. Since most of the algorithms are always available over wikis or competitive coding websites. The above was just a ticket to start a discussion since, I also have aimed to have such a repo in past. We need to comeup with a serious idea if our aim is to provide a common ground for such algorithms. What do you say ? |
|
I do intend to add descriptions about the working of various algorithms, but for now my intention is to have documentation for various functions and user-defined data types, so that when they need to be re-used in other programs, it makes things easier for the user to know, for example, what a certain class is for, what are its data members for, what member functions are available and what input do they take and what output do they give etc. I have given an example of what could be added for now in issue #59. |
Initial commit for Sorting Documentation.