Errors section in README updated.

2.4.8 section added to CHANGELOG

patch bump
This commit is contained in:
onyx-and-iris 2023-08-13 16:52:04 +01:00
parent 2bba0ff67a
commit ce7cda100f
3 changed files with 23 additions and 2 deletions

View File

@ -11,6 +11,24 @@ Before any major/minor/patch bump all unit tests will be run to verify they pass
- [x] - [x]
## [2.4.8] - 2023-08-13
### Added
- Error tests added in tests/test_errors.py
- fn_name and code set as class attributes for CAPIError
- Errors section in README updated.
### Changed
- InstallError and CAPIError classes now subclass VMError
## [2.3.7] - 2023-08-01
### Changed
- If the configs loader is passed an invalid config TOML it will log an error but continue to load further configs into memory.
## [2.3.2] - 2023-07-12 ## [2.3.2] - 2023-07-12
### Added ### Added

View File

@ -845,7 +845,10 @@ True iff a level has been updated.
- `errors.VMError`: Exception raised when general errors occur. - `errors.VMError`: Exception raised when general errors occur.
- `errors.InstallError`: Exception raised when installation errors occur. - `errors.InstallError`: Exception raised when installation errors occur.
- `errors.CAPIError`: Exception raised when the C-API returns error values. - `errors.CAPIError`: Exception raised when the C-API returns error values.
- Error codes are stored in {Exception Class}.code. For a full list of error codes [check the VoicemeeterRemote header file][Voicemeeter Remote Header]. - The following attributes are available:
- `fn_name`: C-API function name.
- `code`: error code
- For a full list of error codes check the [VoicemeeterRemote header file][Voicemeeter Remote Header].
### Logging ### Logging

View File

@ -1,6 +1,6 @@
[tool.poetry] [tool.poetry]
name = "voicemeeter-api" name = "voicemeeter-api"
version = "2.4.7" version = "2.4.8"
description = "A Python wrapper for the Voiceemeter API" description = "A Python wrapper for the Voiceemeter API"
authors = ["onyx-and-iris <code@onyxandiris.online>"] authors = ["onyx-and-iris <code@onyxandiris.online>"]
license = "MIT" license = "MIT"