v1.15.0
Improvement in frozen stubs
Some of the module stubs are generated based on the python modules.
There usually contain little or no docstring information, while the documentation does have that infromation
The stubber tool has been updated to to merge the information from the documentation into these frozen stubs, providing combined and richer information where the two can be matched.
Enrich both Python and C modules
Some of the modules are built partly in (frozen) Python and partly in C(++). by convention the C part of the module is prefixes with an _
an example are the rp2 and the _rp2 modules where the classes and methos of both have been documented in a single document rp2/.st
The documentation merge process will now also enrich the _rp2.pyi and similar named stub files
Quality Testing.
In order to keep an eye on quality, and find cases where the stubs prove incorrect type-hints,
I have setup pytest with some custom configuration to track the quality.
Due to the diversity of features and functionality across ports, boards and versions this should help spot where stubs are not providing the expected/desired results.
( the plan it to move this approach to the stubs repo)
What's Changed
- chore(deps): bump urllib3 from 2.0.6 to 2.0.7 by @dependabot in #432
- chore(deps-dev): bump myst-parser from 0.18.1 to 1.0.0 by @dependabot in #431
- Dev/enrich frozen (Sourcery refactored) by @sourcery-ai in #439
- Fix bug in get-frozen when using version=latest by @samskiter in #442
- add samskiter as a contributor for code by @allcontributors in #444
- Dev/enrich frozen by @Josverl in #433
- chore(deps-dev): bump sphinx-click from 4.4.0 to 5.0.1 by @dependabot in #436
- chore(deps-dev): bump pytest-metadata from 2.0.4 to 3.0.0 by @dependabot in #446
- chore(deps): bump pyright from 1.1.329 to 1.1.334 by @dependabot in #447
- chore(deps-dev): bump pytest-github-actions-annotate-failures from 0.1.8 to 0.2.0 by @dependabot in #437
- chore(deps): bump mypy from 1.2.0 to 1.7.0 by @dependabot in #450
New Contributors
- @samskiter made their first contribution in #442
Full Changelog: v1.14.1...v1.15.0
