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

Hidden Assumptions in Codebase Causing Frequent Errors #33

Open
3 tasks
ChuanyuXue opened this issue Feb 4, 2025 · 0 comments
Open
3 tasks

Hidden Assumptions in Codebase Causing Frequent Errors #33

ChuanyuXue opened this issue Feb 4, 2025 · 0 comments
Assignees

Comments

@ChuanyuXue
Copy link
Owner

There are multiple hidden assumptions in the codebase that are not well-documented. This leads to frequent errors when users run the tool, especially related to common functions used in utils folder, such as input file parsing (#32) and saving result files.

This type of assumptions should be either removed or have clear documentation.

TODO:

  • Identify and document all hidden assumptions in the repo that could cause similar errors.
  • Either modify the code to handle these cases and provide meaningful error messages with suggested fixes.
  • Clearly list all assumptions cannot be fixed in the documentation, like a dedicated “Known Issues” section.
@ChuanyuXue ChuanyuXue self-assigned this Feb 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant