Merge pull request #81 from CardiacModelling/hergQC-docstring

Add hergQC docstrings

Author: MichaelClerx

.gitignore

@@ -1,6 +1,7 @@
 pcpostprocess/_version.py
 /tests/test_data
 /test_output
+/output
 *__pycache__*
 *.egg-info
 *.DS_Store

CHANGELOG.md

@@ -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

CONTRIBUTING.md

@@ -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).