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.

Sign up for GitHub

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

Jump to bottom

Clean up and comment code #8

Open
2 of 5 tasks
ray-chew opened this issue Mar 21, 2024 · 0 comments
Open
2 of 5 tasks

Clean up and comment code #8

ray-chew opened this issue Mar 21, 2024 · 0 comments
Assignees
@ray-chew
Labels
documentation Improvements or additions to documentation
Milestone
Document code

Comments

@ray-chew
Copy link
Owner

ray-chew commented Mar 21, 2024 •
edited
Loading

Now that the essentials of the code are working, it's time to clean-up and comment the code.

  1. Remove all 'print debugs'.
  2. Keep asserts and comment out outputs for debugging purposes.
  3. Remove unnecessary variables in the data containers.
  4. Remove unnecessary initial condtions in the userdata files.
  5. Remove unnecessary comments..
@ray-chew ray-chew changed the title Cleanly separate DA module Clean up and comment code Mar 21, 2024
@ray-chew ray-chew self-assigned this Mar 21, 2024
@ray-chew ray-chew added the documentation Improvements or additions to documentation label Mar 21, 2024
@ray-chew ray-chew added this to the Document code milestone Mar 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ray-chew ray-chew

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
Document code
Development

No branches or pull requests
1 participant
@ray-chew