Fix stale documentation to match current code#93
Merged
Conversation
kahrendt
commented
Jul 14, 2026
kahrendt
commented
Contributor
- server_max_connections default is 4, not 2 (config.h)
- Kalman adaptive-forgetting cutoff/factor are 3.0/2.0, not 2.0/1.1
- artwork decode thread uses only COMMAND_STOP; COMMAND_FLUSH is visualizer-only
- drop reference to nonexistent NullAudioSink in basic_client README
- server_max_connections default is 4, not 2 (config.h) - Kalman adaptive-forgetting cutoff/factor are 3.0/2.0, not 2.0/1.1 - artwork decode thread uses only COMMAND_STOP; COMMAND_FLUSH is visualizer-only - drop reference to nonexistent NullAudioSink in basic_client README
Contributor
There was a problem hiding this comment.
Pull request overview
Updates project documentation to accurately reflect current runtime defaults and thread/role behavior in the sendspin-cpp client, removing stale or incorrect references that no longer match the implementation.
Changes:
- Update basic_client README to remove the nonexistent
NullAudioSinkreference and describe the actual non-PortAudio fallback behavior. - Update internals documentation for event-flag command usage (artwork vs visualizer) and Kalman adaptive-forgetting parameters.
- Update integration guide default for
server_max_connections(and rationale) to matchSendspinClientConfig.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| examples/basic_client/README.md | Removes NullAudioSink mention; documents the real PortAudio-absent behavior (bytes tallied, audio discarded). |
| docs/internals.md | Aligns thread command-flag descriptions and Kalman adaptive-forgetting constants with current code. |
| docs/integration-guide.md | Corrects server_max_connections default to 4 and documents the connection budget rationale. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
kahrendt
enabled auto-merge (squash)
July 14, 2026 12:43
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.