Small fixes to API documentation & README #347
Merged
Conversation
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
I mistakenly added some functions in the wrong order. This commit fixes that.
The function `cass_cluster_set_queue_size_event` is a no-op in both the CPP driver and the Rust wrapper. This may be confusing to further implementors, so let's mark it as such in the `api.rs`.
There was a problem hiding this comment.
Pull Request Overview
This PR performs minor documentation and comment organization improvements across the codebase. The changes focus on alphabetizing API function listings and correcting documentation headers for clarity.
- Reorganizes API function comments in alphabetical order for better readability
- Corrects a documentation header from "CassColumn" to "CassColumnMeta"
- Adds missing API functions to the unimplemented features list in README
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| scylla-rust-wrapper/src/api.rs | Alphabetizes function comments and adds clarifying comment about no-op behavior |
| README.md | Fixes header name and adds missing unimplemented API functions to documentation |
This fixes an obvious mistake I made.
Two functions were missing from the README.md file in the list of unimplemented functions: - `cass_value_get_custom()`, - `cass_cluster_set_max_connections_per_host()`. They are now added to the list.
wprzytula
force-pushed
the
api-docs-cleanup
branch
from
31f8c1e to
20504e9
Compare
Lorak-mmk
approved these changes
Jul 16, 2025
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.
Pre-review checklist
[ ] I have implemented Rust unit tests for the features/changes introduced.[ ] I have enabled appropriate tests inMakefilein{SCYLLA,CASSANDRA}_(NO_VALGRIND_)TEST_FILTER.[ ] I added appropriateFixes:annotations to PR description.