Documentation - Githubissues

AFD-Illinois / iharm2d_v4

A 2D ideal GRMHD code derived from iharm3d with fewer dependencies and better documentation

BSD 3-Clause "New" or "Revised" License

7 stars 2 forks source link

Closed vedantdhruv96 closed 1 year ago

vedantdhruv96 commented 1 year ago

Improve code documentation in the way of,

[x] removing TODOs carried over from iharm3d, workarounds specific to iharm3d, e.g., INTEL_WORKAROUND, any other additional comments ported from iharm3d that are not applicable to iharm2d_v4,
[x] ensuring headers for every file summarize the functionalities of the said file,
[x] inserting comments for each function in the code,
[x] explaining seemingly ad-hoc decisions in the code.

vedantdhruv96 commented 1 year ago

I believe I've dealt with all of these, but I've looked at harm for too long to may have missed something that appears ad-hoc to a new user.