jqueuniet/opl-audio
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: tighten crate packaging and document the public API #1

Merged
jqueuniet merged 1 commit from chore/publish-polish into main 2026-07-23 09:29:42 +02:00
Conversation 0 Commits 1 Files changed 3 +89 -17
jqueuniet commented 2026-07-23 09:27:22 +02:00
Owner
Copy link

Publish-readiness polish ahead of crates.io.

Packaging

  • Add exclude = [".idea", ".forgejo", "deny.toml"] to Cargo.toml so the published tarball ships only source, licenses, README, and the example (IDE/CI-only files no longer bloat the crate).

Docs

  • Enable #![warn(missing_docs)] and document every public item: OplOperator/OplPatch fields, OplBank methods, MidiMsg variants, TimedEvent/RenderOpts/Pcm/StereoPcm fields, Error, and render(). Improves docs.rs quality and guards against future undocumented API.

No behavior change. cargo fmt/clippy/test/doc (all with -D warnings) pass; 54 tests green.

Publish-readiness polish ahead of crates.io. **Packaging** - Add `exclude = [".idea", ".forgejo", "deny.toml"]` to `Cargo.toml` so the published tarball ships only source, licenses, README, and the example (IDE/CI-only files no longer bloat the crate). **Docs** - Enable `#![warn(missing_docs)]` and document every public item: `OplOperator`/`OplPatch` fields, `OplBank` methods, `MidiMsg` variants, `TimedEvent`/`RenderOpts`/`Pcm`/`StereoPcm` fields, `Error`, and `render()`. Improves docs.rs quality and guards against future undocumented API. No behavior change. `cargo fmt`/`clippy`/`test`/`doc` (all with `-D warnings`) pass; 54 tests green.
chore: tighten crate packaging and document the public API
All checks were successful
CI / stable (pull_request) Successful in 15s
Details
CI / msrv (1.90) (pull_request) Successful in 18s
Details
CI / audit (pull_request) Successful in 9s
Details
CI / msrv (1.90) (push) Successful in 19s
Details
CI / audit (push) Successful in 9s
Details
CI / stable (push) Successful in 15s
Details
06e5dc2a36
 
- Exclude .idea, .forgejo, and deny.toml from the published tarball so
  only source, licenses, README, and the example ship.
- Enable #![warn(missing_docs)] and document every public item: OplOperator/
  OplPatch fields, OplBank methods, MidiMsg variants, TimedEvent/RenderOpts/
  Pcm/StereoPcm fields, Error, and render().

cargo fmt/clippy/test/doc (with -D warnings) all clean.
jqueuniet deleted branch chore/publish-polish 2026-07-23 09:29:42 +02:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
jqueuniet/opl-audio!1
No description provided.