fix(docs): correct OSCQueryServiceBuilder.WithDefaults() usage#64
Merged
orels1 merged 1 commit intoOct 9, 2025
Merged
Conversation
- Update README.md Basic Use section with correct example - Fix getting-started.md fluent interface examples - Add warnings about WithDefaults() immediate server startup - Clarify that settings must be configured before WithDefaults()
|
CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅ |
Contributor
Author
|
I have read the CLA Document and I hereby sign the CLA |
Contributor
|
Thank you for clarifying this! |
orels1
approved these changes
Oct 9, 2025
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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.
Fix: WithDefaults() Usage Documentation
Problem
The
OSCQueryServiceBuilder.WithDefaults()method immediately starts the HTTP server and advertising, causing any subsequent configuration methods to be ignored. The current documentation showed examples using this problematic pattern.Solution
README.md Basic Use section:
getting-started.md Fluent Interface Options:
WithDefaults()descriptionFixes #40
Method realization of OSCQueryserviceBuilder.WithDefaults() is confusing