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

Document various "aux" functions and additional helpers #101

Closed
sbarfurth opened this issue Jul 31, 2018 · 2 comments
Closed

Document various "aux" functions and additional helpers #101

sbarfurth opened this issue Jul 31, 2018 · 2 comments

Comments

@sbarfurth
Copy link
Collaborator

The code is littered with helpers that some might not understand. To enable contributions these functions need to be described in a comment. It can be kept brief but should say what the function does and what it returns. Especially those functions returning functions need to receive this treatment. This is an important step in cleaning the code.

@imbrn
Copy link
Owner

imbrn commented Aug 1, 2018

I'll change some variable and functions names soon to improve code readability. I'm also working on a docs section explaining better how the algorithm which connects rules and modifiers together works.

@sbarfurth
Copy link
Collaborator Author

Once these are slightly refactored and correctly documented I will tackle #48 again.

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

No branches or pull requests

2 participants