Skip to content

Small fixes to API documentation & README #347

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 16, 2025

Conversation

wprzytula
Copy link
Collaborator

Pre-review checklist

  • I have split my patch into logically separate commits.
  • All commit messages clearly explain what they change and why.
  • PR description sums up the changes and reasons why they should be introduced.
  • [ ] I have implemented Rust unit tests for the features/changes introduced.
  • [ ] I have enabled appropriate tests in Makefile in {SCYLLA,CASSANDRA}_(NO_VALGRIND_)TEST_FILTER.
  • [ ] I added appropriate Fixes: annotations to PR description.

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`.
@wprzytula wprzytula requested review from Lorak-mmk and Copilot July 16, 2025 07:43
@wprzytula wprzytula self-assigned this Jul 16, 2025
@wprzytula wprzytula added the documentation Improvements or additions to documentation label Jul 16, 2025
@wprzytula wprzytula added this to the 0.6 milestone Jul 16, 2025
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 wprzytula modified the milestones: 0.6, 0.5.1 Jul 16, 2025
@wprzytula wprzytula merged commit b5670c1 into scylladb:master Jul 16, 2025
11 checks passed
@wprzytula wprzytula deleted the api-docs-cleanup branch July 16, 2025 09:54
@wprzytula wprzytula mentioned this pull request Jul 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants