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

Code Formatting and Documentation #5

Closed
ijacobs-cpa opened this issue Sep 15, 2023 · 1 comment
Closed

Code Formatting and Documentation #5

ijacobs-cpa opened this issue Sep 15, 2023 · 1 comment

Comments

@ijacobs-cpa
Copy link

Code formatting:

Having non-function code around (above and below) your functions makes it a bit confusing to understand how the code flows. Maybe consider grouping the functions in one area and having the non-function code below (or above) the functions to stand out. Also maybe include a main() (non-issue) so that it looks more clearer to a user.

Your code could also use a bit more documentation to explain what is happening at certain lines of code (For example in your process_txt_file() function adding more comments when opening a file for reading/writing)

@mingming-ma
Copy link
Owner

Fix this issue in this commit 0aaff97

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

2 participants