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

Add Documentation and Comments #72

Open
raviverma2791747 opened this issue May 15, 2020 · 1 comment
Open

Add Documentation and Comments #72

raviverma2791747 opened this issue May 15, 2020 · 1 comment
Labels
enhancement New feature or request

Comments

@raviverma2791747
Copy link

Please add comments in the source codes so that others can contribute to it.

@Dandigit
Copy link
Member

This is definitely a goal of mine, and somewhat of a focus at the moment as I work towards merging my replacement for the Analyser module. I've been making an effort to leave comments where necessary, when the purpose of some data or code is not immediately clear.

You are absolutely right that a lot more work needs to be done to make the codebase more approachable for first-time contributors, and I hope that working towards the resolution of this issue as well as #46 can accomplish this.

In the longer term, I'd like to look at using something like Doxygen to make managing all of this a bit more standardised.

@Dandigit Dandigit added the enhancement New feature or request label Jun 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants