Major rework to improve code quality, add automation checks and self hosted autogenerated documetnation website#543
Conversation
# Conflicts: # .travis.yml # DIRECTORY.md # README.md
* commit '0538404f8652bb8f80d362eab2bf988a3eb545bd': added link to compile and run code online Gist to run and test the Durand-Kerner Algorithm online and view the roots convergence better formatting of root values updating DIRECTORY.md another shell-sort implementation updating DIRECTORY.md remove timing calculation compute real eigen values of a square matrix using shit and deflate QR decomposition algorithm QR decomposition of any matrix with real elements Durand Kramer method for roots of any polynomial # Conflicts: # DIRECTORY.md # numerical_methods/durand_kerner_roots.c # numerical_methods/qr_decomposition.c # numerical_methods/qr_eigen_values.c
|
what's the status of this pull request? |
This is exactly identical to the we closed at C++ repo. |
|
oh i mean if anyone of the reviewer has reviewed some of the files or not, if not then i will start from the very first file. @deadshotsb |
to mimic changes in C++ repo
| [](https://github.com/kvedala/C-Plus-Plus/blob/master/CONTRIBUTING.md) | ||
|  | ||
|  | ||
|  | ||
|  |
There was a problem hiding this comment.
All these badges are pointing to your repository.
Shouldn't it point to the TheAlgorithms?
There was a problem hiding this comment.
Yes, I will change them once the PR is ready to be merged. Thats what I did in the C++ repository as well
|
Any update here? |
|
Sorry, I haven't looked at all the files but I think a lot of the files are not using the Doxygen commenting style, is that okay? It may be that we may need to write comments ourselves to improve the documentation |
No worries, take your time. @ayaankhan98 and I think @deadshotsb are also reviewing. Regarding documentations, yes, almost none of the existing files had documentations. I added to a few. But it would require a collaborative effort to update the documentations on the existing code. This was the same approach we used for the C++ repo where contributors like yourself, @ayaankhan98, @Panquesito7 and others have helped improve the code documentation. |
Brilliant, once this PR is merged then we can start doing that😄 |
|
Moreover, the LGTM like checks cannot be implemented properly until this merge comes through. The CMake tool for the repo provides with that cross-platform cohesion required. In fact, there were (and some still exist) codes that do not even compile. In one on the repo folders, all C code is just functions and without a |
yes i observed, i think this is the common practice of this repository people pushes the code without main function, i don't know how they even test their code. i think they just type some code and push without even testing. |
|
In fact, looking at the repo, even I got lazy and my initial commits were without much documentation either 😏 and then the epiphany to see if the repo can be resuscitated. I made a few changes on my fork and got some good feedback from viewers. Then came this pull-request |
github-actions
bot
force-pushed
the
master
branch
from
4581d63 to
f221bea
Compare
|
Thank you @ayaankhan98 |
|
Checklist:
|
yes i think we can merge this now, further improvement in code quality can be done after merging this. (same as we done in C++ repo) |
7 participants
Description of Change
cmakebased structurecmaketo check code compilation on linux (ubuntu), Mac OS and Windows (using MS Visual C/C++ compiler)This documentation approach will also enable other contributors to add documentation in their respective languages or use google translate to do so.
Checklist
Note
Before merging, the parent repository branch structure would need to be improved (Adding images branch, adding gh-pages branch). Unless existing maintainers are up for the challenge, I,d like to volunteer to maintain the structure of the repo and the documentation of the same. It’d allow us to have graphs and files for a much better documentation.