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 comments to the engine code #130

Closed
V0ldek opened this issue May 1, 2023 · 1 comment · Fixed by #501
Closed

Add comments to the engine code #130

V0ldek opened this issue May 1, 2023 · 1 comment · Fixed by #501
Assignees
Labels
type: reliability Tests, code quality
Milestone

Comments

@V0ldek
Copy link
Member

V0ldek commented May 1, 2023

Is your feature request related to a problem? Please describe.
It's impossible to understand all the checks and edge cases inside the engine code without having someone explain it to you.

Describe the solution you'd like

  1. What can be refactored to be more descriptive, should. This is not always possible, especially in recursive due to the control-flow, but some might.
  2. Change names of locals to more reflect their domain-specific meaning, and less the implementation details.
  3. Add comments where meaning is still not clear.
@V0ldek V0ldek added the type: reliability Tests, code quality label May 1, 2023
@github-actions github-actions bot added the acceptance: triage Waiting for owner's input label May 1, 2023
@github-actions
Copy link

github-actions bot commented May 1, 2023

Tagging @V0ldek for notifications

@V0ldek V0ldek added this to the v1.0.0 milestone May 1, 2023
@V0ldek V0ldek self-assigned this May 1, 2023
@github-actions github-actions bot added acceptance: go ahead Reviewed, implementation can start and removed acceptance: triage Waiting for owner's input labels May 1, 2023
@github-actions github-actions bot removed the acceptance: go ahead Reviewed, implementation can start label Apr 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: reliability Tests, code quality
Projects
Development

Successfully merging a pull request may close this issue.

1 participant