Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upMajor rework to improve code quality and add automation checks #805
Conversation
Documentation for files in the folder `others`
* document/others: fix happy number code and documetnation added see also reference to fibonacci
* document/math: replace printf & scanf with std::cout and std::cin documented factorial
Fix Doxygen CI to use doxygen v1.8.18
Yes please, only if these are the files that exist in the parent repo. All code that I have written includes extensive documentation. |
Please note that before merging, some links will need to be updated to reflect to parent repo links. These can be done in one last commit |
Signed-off-by: Krishna Vedala <7001608+kvedala@users.noreply.github.com>
@mishraabhinn could you please also help @ayaankhan98 to review this pull. It is quite an extensive one trying to improve the standards of this repo. |
i have reviewed approx 160 files, half of them are still remaning |
@ayaankhan98 appreciate your work, then I am starting from file 161. |
I wish there was a better way to do this but the repo is so bad that to fit it up consistently, it was the best I could. I tried to help by pointing to the merges to master branch - and still think that would be the easiest thing to do. |
@kvedala we are have finished half of the work, it will take some more time then we are all done, further improvement will be easy as after this PR we have automation checks |
Thats the goal - that from this point on, the documentation, program execution checks, etc would all be streamlined - simplifying it for both the authors and the reviewers. |
Signed-off-by: Krishna Vedala <7001608+kvedala@users.noreply.github.com>
Signed-off-by: Krishna Vedala <7001608+kvedala@users.noreply.github.com>
Signed-off-by: Krishna Vedala <7001608+kvedala@users.noreply.github.com>
Signed-off-by: Krishna Vedala <7001608+kvedala@users.noreply.github.com>
Signed-off-by: Krishna Vedala <7001608+kvedala@users.noreply.github.com>
Numerical methods - LU and QR decomposition of matrices
Signed-off-by: Krishna Vedala <7001608+kvedala@users.noreply.github.com>
Signed-off-by: Krishna Vedala <7001608+kvedala@users.noreply.github.com>
I have np @kvedala in doing that, I have forked this for contribution only. If @ayaankhan98 can guide me little bit I will happy to help because of new to all this. |
#836 fixed |
kvedala commentedMay 29, 2020
•
edited
Description of Change
cmake
based structurecmake
to check code compilation on linux (ubuntu), Mac OS and Windows (using MS Visual C++ compiler)This documentation approach will also enable other contributors to add documentation in their respective languages or use google translate to do so.
There is a pull-request (#795) for a smaller subset of the changes made
Checklist
Notes: