Skip to content

Add hergQC docstrings #81

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

Merged
MichaelClerx merged 18 commits into from
Nov 11, 2025
Merged

Add hergQC docstrings #81

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
527f6b6
Slightly tidying hergQC.py
MichaelClerx Oct 16, 2025
e7de3a2
Removed unused qc2 and qc3 options
MichaelClerx Oct 17, 2025
299df40
Merge branch 'main' into hergQC-docstring
MichaelClerx Oct 17, 2025
1acc6a9
Working on docstrings for hergQC module
MichaelClerx Nov 3, 2025
1bf5c16
Merge branch 'main' into hergQC-docstring
MichaelClerx Nov 3, 2025
f1b1ba2
Added docstrings to hergQC
MichaelClerx Nov 4, 2025
c403a3a
Made filter_capacitive_spikes public again
MichaelClerx Nov 4, 2025
b3a93cb
Made filter_capacitive_spikes accept 1-d arrays again.
MichaelClerx Nov 4, 2025
50360f6
Made filter_capacitive_spikes accept 1-d arrays again.
MichaelClerx Nov 4, 2025
9d22edb
Updated run_herg_qc to not use unnecessary n_sweeps constructor arg
MichaelClerx Nov 5, 2025
f305a42
Added voltage to hergqc construction in run_herg_qc call
MichaelClerx Nov 5, 2025
9ee4de5
Merge branch 'main' into hergQC-docstring
MichaelClerx Nov 5, 2025
e6b480d
Added new generated version file to gitignore
MichaelClerx Nov 5, 2025
4ce60be
Style fix
MichaelClerx Nov 5, 2025
e52b2c4
Merge branch 'main' into hergQC-docstring
MichaelClerx Nov 11, 2025
4170554
Merge branch 'main' into hergQC-docstring
MichaelClerx Nov 11, 2025
430fd64
Clarified changelog use in contributing.md
MichaelClerx Nov 11, 2025
7300038
Updated changelog
MichaelClerx Nov 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
pcpostprocess/_version.py
/tests/test_data
/test_output
/output
*__pycache__*
*.egg-info
*.DS_Store
Expand Down
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,13 @@ This page lists the main changes made to pcpostprocess in each release.

## Unreleased
- Added
- [#81](https://github.com/CardiacModelling/pcpostprocess/pull/81) Added docstrings to the `hERGQC` class.
- [#104](https://github.com/CardiacModelling/pcpostprocess/pull/104) Added a CHANGELOG.md and CONTRIBUTING.md
- Changed
- [#81](https://github.com/CardiacModelling/pcpostprocess/pull/81) Changed the constructor arguments for `hERGQC`.
- Deprecated
- Removed
- [#81](https://github.com/CardiacModelling/pcpostprocess/pull/81) Removed `hERGQC.plot_dir`, `hERGQC.set_trace` and `hERGQC.set_debug`.
- Fixed

## [0.2.0] - 2025-11-11
Expand Down
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,9 @@ For example, the first entry in our Changelog was:
- [#104](https://github.com/CardiacModelling/pcpostprocess/pull/104) Added a CHANGELOG.md and CONTRIBUTING.md
```

Changelog entries are intended for _users_, and so should focus on changes to the public API or command line interface.
Changes to internals are less likely to need reporting.

## Packaging

This project uses a minimal [`setup.py`](./setup.py), and instead uses [pyproject.toml](./pyproject.toml).
Expand Down
Loading