Release v0.3.1

[yohanchatelain]

No description provided.

[Copilot]

Pull Request Overview

This PR bumps the release version to v0.3.1 and makes significant code clean-ups and refactoring. Key changes include:

• Adding format_uncertainty to the public API in init.py.
• Removing legacy test and C extension files (test_cramer.py, truncation.py, truncation.c, float_struct.h, float_const.h, Makefile).
• Updating project configuration and workflows (pyproject.toml and GitHub Actions) along with documentation changes.

Reviewed Changes

Copilot reviewed 41 out of 41 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
src/significantdigits/init.py	Added format_uncertainty to the public API list.
significantdigits/test/test_cramer.py	Entire test file removed, reducing test coverage for Cramer's rule.
significantdigits/src/truncation.py	Removed truncation module in Python.
significantdigits/src/truncation.c	Removed C extension for truncation functionality.
significantdigits/src/float_struct.h	Removed low-level header used for floating-point manipulation.
significantdigits/src/float_const.h	Removed floating-point constant definitions.
significantdigits/src/Makefile	Removed build Makefile for the C library.
pyproject.toml	Updated version and adjusted build dependencies/exclusions.
GitHub workflow files	Upgraded actions versions and updated install commands.
README.md	Updated version, added a table of contents, and enriched examples.
examples/*	Added new example scripts for getting started and analysis.

Comments suppressed due to low confidence (8)

src/significantdigits/init.py:12

• Ensure that the newly exposed 'format_uncertainty' function is documented (e.g. in docstrings and the README) so that consumers of the public API know its purpose and usage.

+    format_uncertainty,

significantdigits/test/test_cramer.py:1

• The removal of test_cramer.py reduces test coverage for the Cramer rule functionality. Consider adding equivalent tests elsewhere (e.g., in an examples-based test suite) to maintain verification for this algorithm.

Entire test file removed

significantdigits/src/truncation.py:1

• The removal of the truncation module in Python indicates a significant change in available functionality. Make sure that dependent modules and documentation are updated to reflect this change.

Entire file removed

significantdigits/src/truncation.c:1

• Removing the C extension for truncation may affect performance-sensitive operations. Confirm that these changes are intentional and that any required migration steps are clearly documented.

Entire file removed

significantdigits/src/float_struct.h:1

• The deletion of the float_struct.h header, which was used for low-level floating-point manipulation, should be reviewed to ensure that no other parts of the code depend on it.

Entire file removed

significantdigits/src/float_const.h:1

• Removing float_const.h eliminates all the floating-point constants previously defined. Verify that these constants are not required by any remaining or future modules, and update the documentation if necessary.

Entire file removed

significantdigits/src/Makefile:1

• The removal of the Makefile indicates a shift in the build process. Update the build and deployment documentation so that users know how to build the C extensions (if still required) or that they have been deprecated.

Entire file removed

.github/workflows/python-app.yml:34

• The modified install command now installs the package along with the requirements. Ensure that all necessary packages are correctly listed so that the workflow environment mirrors production dependencies.

if [ -f requirements.txt ]; then pip install . -r requirements.txt; fi