Skip to content

1.7.1 — the published API pages described a band this package no longer uses - #363

Merged
alexarje merged 1 commit into
masterfrom
docs-band-1.7.1
Aug 5, 2026
Merged

1.7.1 — the published API pages described a band this package no longer uses#363
alexarje merged 1 commit into
masterfrom
docs-band-1.7.1

Conversation

@alexarje

@alexarje alexarje commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

The committed API pages showed group_qom(points, fs, lo=0.3, hi=15.0) and deep-linked into musicalgestures/_qom.py at line numbers that stopped existing when those functions moved to micromotion on 2026-07-29. Regenerated from the current source with scripts/regenerate_api_docs.sh. The band is micromotion.BAND, 0.2–5 Hz.

That script does not touch hand-written pages, so docs/user-guide/pose-tracking.md and docs/user-guide/sound-movement-toolkit.md were corrected by hand. Both stated 0.3 Hz and one passed lo=0.3, hi=15.0 in an example a reader would copy.

The dependency floor was wrong twice over

micromotion>=0.3 names a release that does not exist on PyPI below 0.6, and the functions this package re-exports arrived far later, so the constraint permitted an installation where from musicalgestures import group_qom fails. Now >=0.15.2, which is also the floor that makes the committed API pages true, since they are generated from that package's docstrings.

The generated pages got shorter, on purpose

_qom.md and _posture.md lose several hundred lines because those modules are re-export shims and handsdown documents what is in the module. The old length came from documenting functions that had already moved. The three shims now point at https://fourms.github.io/micromotion/ so a reader has somewhere to go.

No behaviour changed. 545 tests pass locally against micromotion 0.15.2.

🤖 Generated with Claude Code

https://claude.ai/code/session_01Qx7SWwc4XGYgXNNKrcNAgP

…er uses

The committed pages showed `group_qom(points, fs, lo=0.3, hi=15.0)` and linked
into `musicalgestures/_qom.py` at line numbers that stopped existing when those
functions moved to `micromotion` on 2026-07-29. They are regenerated from the
current source. The band is `micromotion.BAND`, 0.2-5 Hz.

The regeneration script does not touch hand-written pages, so
`docs/user-guide/pose-tracking.md` and `docs/user-guide/sound-movement-toolkit.md`
were corrected by hand; both stated 0.3 Hz and one passed `lo=0.3, hi=15.0` in
an example.

The `micromotion` floor was `>=0.3`, which is wrong twice over: no such release
exists on PyPI below 0.6, and the functions re-exported here arrived much later,
so the constraint permitted installations in which importing them fails. It is
now `>=0.15.2`, which is also the floor that makes the committed API pages true,
since they are generated from that package's docstrings.

The three re-export shims now point at https://fourms.github.io/micromotion/.
Their generated pages describe the shim rather than the functions, which is
correct but left a reader with nowhere to go.

No behaviour changed. 545 tests pass.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Qx7SWwc4XGYgXNNKrcNAgP
@alexarje
alexarje merged commit 01ac394 into master Aug 5, 2026
12 checks passed
@alexarje
alexarje deleted the docs-band-1.7.1 branch August 5, 2026 13:53
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.

1 participant