Skip to content

Conversation

@MichaelClerx
Copy link
Member

@MichaelClerx MichaelClerx commented Jul 15, 2025

Fixes #14

  • Added sphinx docs
  • Added instructions to README.md, along with more developer info
  • Improved and added missing docstrings where possible
  • Turned VoltageProtocol.from_x methods from implicit static into explicitly declared classmethods (allowing inheritance)
  • Added version number stored in file, used by code, setup.py, and docs
  • Used ' and " consistently
  • Full test coverage, fixes Try and get code coverage closer to 100% #6

Also raised some questions in #15 #16 #17 #18 and there are still other docstrings in Trace that could use a bit of work (what exactly is the output, what is a "trace file index" and what is the format "sweeps" are returned in etc

@codecov
Copy link

codecov bot commented Jul 15, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.87%. Comparing base (f3b3dc4) to head (41b8d35).
Report is 28 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #21      +/-   ##
==========================================
+ Coverage   95.07%   97.87%   +2.80%     
==========================================
  Files           3        3              
  Lines         284      283       -1     
==========================================
+ Hits          270      277       +7     
+ Misses         14        6       -8     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@MichaelClerx MichaelClerx changed the title Added documentation Added documentation, tests, and more Jul 16, 2025
@MichaelClerx MichaelClerx requested a review from kwabenantim July 16, 2025 07:39
@kwabenantim kwabenantim self-requested a review July 16, 2025 10:08
Copy link
Member

@kwabenantim kwabenantim left a comment

Choose a reason for hiding this comment

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

Everything looks good to me, just needs a minor update to flake8 settings.

Co-authored-by: Kwabena Amponsah <kwabenantim@yahoo.com>
@MichaelClerx MichaelClerx merged commit 97cea0d into main Jul 16, 2025
10 checks passed
@MichaelClerx MichaelClerx deleted the docs branch July 16, 2025 10:53
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.

Add API docs Try and get code coverage closer to 100%

3 participants