Correct SDK documentation and examples - #729
Draft
teodordelibasic-db wants to merge 2 commits into
Draft
Conversation
Signed-off-by: teodordelibasic-db <teodor.delibasic@databricks.com>
Signed-off-by: teodordelibasic-db <teodor.delibasic@databricks.com>
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
1 participant
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.
What changes are proposed in this pull request?
Correct README snippets, checked-in examples, and public API doc examples across the SDKs so they compile and demonstrate the current APIs. The changes also align ingestion examples on queue-then-flush durability, correct recovery and callback semantics, and add a runnable generated-message fixture for the .NET Protobuf example.
The accompanying
snippet-audit.mdrecords every correction and lists functional SDK issues discovered during validation. Those functional issues are intentionally left unchanged for separate follow-up work.How is this tested?
All runnable examples and executable documentation snippets were compiled or type-checked for Rust, Python, Java, Go, pure Go, TypeScript, C++, and .NET. Representative JSON, Protobuf, Arrow, batch, recovery, and custom-header paths were also exercised against local test endpoints.
The affected SDK formatters, linters, unit tests, example builds, and doc tests pass. The .NET suite passes 47 unit and 54 integration tests. TypeScript build, tests, and example type-check pass; its all-features Clippy check still reports three pre-existing warnings unrelated to these documentation changes. The C++ Arrow example was source-reviewed but not linked because Apache Arrow C++ was unavailable; the other C++ examples built and their JSON batch and custom-header paths were exercised.