Skip to content

Revise stormpy modules#245

Merged
volkm merged 12 commits into
stormchecker:masterfrom
volkm:modules
Jul 14, 2025
Merged

Revise stormpy modules#245
volkm merged 12 commits into
stormchecker:masterfrom
volkm:modules

Conversation

@volkm

@volkm volkm commented Jun 30, 2025

Copy link
Copy Markdown
Contributor
  • Add an underscore suffix to all pybind libraries, e.g. _storage instead of storage. This helps distinguishing between the Python module storage and the pybind library _storage. Some adaptions were required but nothing should change on the outside.
  • Added new module stormpy.exceptions and added type information to docstring
  • Revised documentation for stormpy.info. I tried making the functions storm_version(), etc properties, but this lead to issues because the property decorator is aimed at classes and not modules.
  • Generate API documentation for stormpy.pomdp
  • Use sphinx decorator for deprecation. Deprecations now require a version and I opted to use the last version 1.10.0. Technically the deprecation was only introduced afterwards, but otherwise we need to reference a future version without knowing what version number we will actually have.
  • Our Sphinx documentation generates documentation also for imported members (to include the pybind libraries). I needed to explicitly exclude the deprecated import as it would occur in the documentation otherwise. We have to keep an eye on future imports which we also might need to exclude.

@volkm volkm marked this pull request as ready for review June 30, 2025 21:13
@sjunges

sjunges commented Jul 11, 2025

Copy link
Copy Markdown
Contributor

LGTM!

@volkm volkm merged commit 7e3984f into stormchecker:master Jul 14, 2025
20 checks passed
@volkm volkm deleted the modules branch July 14, 2025 08:23
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.

2 participants