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

Clarify main function #40

Open
beszel opened this issue Jan 2, 2020 · 0 comments
Open

Clarify main function #40

beszel opened this issue Jan 2, 2020 · 0 comments
Labels
enhancement New feature or request

Comments

@beszel
Copy link
Contributor

beszel commented Jan 2, 2020

Is your feature request related to a problem? Please describe.
The main function is hard to read, and it's not immediately clear what its for loops are doing.

Describe the solution you'd like
The function could use a more descriptive doctag. The content of the function should be split into helper functions with meaningful names. Remaining points of ambiguity can be clarified with comments.

Describe alternatives you've considered
We could leave everything as-is, which might make sense if we never expect to modify the main function. I expect that we'll need to modify the main function.

Additional context
Other functions could probably use cleanup too, but this one is particularly apparent.

@beszel beszel added the enhancement New feature or request label Jan 2, 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

1 participant