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

[ Feature Request ] In Code and General Documentation #2725

Open
PeterHindes opened this issue Oct 14, 2019 · 2 comments
Open

[ Feature Request ] In Code and General Documentation #2725

PeterHindes opened this issue Oct 14, 2019 · 2 comments
Labels
discussion This needs to be discussed before anything is done help wanted Help is wanted in fixing this issue meta Related to the project but not strictly to code

Comments

@PeterHindes
Copy link
Contributor

There doesn't seem to be an appropriate amount of comments. This is pretty concerning as it means that new contributors (ie. me) may be somewhat lost. I know that this wont improve the functionality of the code directly, but it will make the code more approachable to new contributors. I plan to write some more in code and out of code docs as i become familiar with the project, but I would appreciate some help with this fairly large task. So if you have some free time feel free to work on some docs. 😊

@PeterHindes
Copy link
Contributor Author

I have found the general docs on the main site. But i still think the code needs some better docs. IDK, maybe I'm just being picky.

@Stypox Stypox added discussion This needs to be discussed before anything is done help wanted Help is wanted in fixing this issue labels Oct 15, 2019
@opusforlife2
Copy link
Collaborator

Agreed. I found it pretty confusing as well to figure out which function was doing what, and where values were coming from.

@SameenAhnaf SameenAhnaf added the meta Related to the project but not strictly to code label Jan 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion This needs to be discussed before anything is done help wanted Help is wanted in fixing this issue meta Related to the project but not strictly to code
Projects
None yet
Development

No branches or pull requests

4 participants