Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Code Documentation #200

Open
dabockster opened this issue Aug 23, 2018 · 4 comments
Open

Code Documentation #200

dabockster opened this issue Aug 23, 2018 · 4 comments

Comments

@dabockster
Copy link

@dabockster dabockster commented Aug 23, 2018

There is very little documentation available for the source code. As such, the source is highly difficult to understand and interpret by others. Please consider adding in appropriate documentation as soon as possible.

@crazyBaboon
Copy link

@crazyBaboon crazyBaboon commented Sep 9, 2018

And yet, because it is written in C, it is still easier to understand than the utter mess going on in Minetest C++ source code.

@htmlboss
Copy link

@htmlboss htmlboss commented Sep 10, 2018

I find the code fairly readable to be honest (and I'm coming from a c++ background). Yes it's very long-winded in places but try breaking things into chunks in your mind.

@crazyBaboon
Copy link

@crazyBaboon crazyBaboon commented Sep 20, 2018

Unfortunately this project seems to be dead.

@ignacionr
Copy link

@ignacionr ignacionr commented Apr 11, 2020

@dabockster I am helping a person just out of high school learn C, and they find it very easy to read. IMHO, including comments within the code would lead to disconnects and bloat the line number count, discouraging people to read the actual C language.

@crazyBaboon the project is not dead. The maintainer has been accepting PRs. What I think is happening, is that he simply disregards issues that should be addressed by the same posters (e.g. if my proposal would be to have documentation, then I would offer a PR with .md files).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
4 participants
You can’t perform that action at this time.