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

fix: add detailed inline comments to improve code readability (#80) #84

Merged
merged 5 commits into from
Feb 2, 2025

Conversation

htang085
Copy link
Collaborator

@htang085 htang085 commented Feb 2, 2025

Description

This branch addresses feedback provided in Issue #80. Specifically, it:

  • Adds detailed inline comments to improve the readability of the save_data.py function.
  • Clarifies the purpose of each step in the code (e.g., directory validation, error handling, and file saving).

Related Issue

Fixes #80

Copy link

codecov bot commented Feb 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (83c890c) to head (4f6e4b3).
Report is 7 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #84   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            4         4           
  Lines           57        57           
=========================================
  Hits            57        57           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@lixuanlinjam lixuanlinjam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!! a lot of details get fixed!

@htang085 htang085 merged commit 0b7f53f into main Feb 2, 2025
6 checks passed
@htang085 htang085 deleted the add-inline-comments branch February 2, 2025 21:41
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

Successfully merging this pull request may close these issues.

have a bit more inline comments in functions like save_data.py
2 participants