scylladb / scylladb/python-rs-driver

docs: Core usage docs

Open
#85 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area/documentation
Dominant language
Rust
Stars
6
Forks
7
Avg merge
5d 13h
Merged PRs (30d)
9

Description

Document the main day-to-day driver usage. Cover executing statements, prepared statements, parameter binding, handling results, data types, batches, and error handling, with runnable examples where possible.

Populate the following pages with content:

  • Using the Driver
  • Executing statements
  • Prepared statements
  • Binding parameters
  • Handling results
  • Data types
  • Batches
  • Error handling

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the existing documentation structure for the pages listed in the issue, then inspect the driver's day-to-day usage and available runnable examples. Cover executing and preparing statements, parameter binding, results, data types, batches, and errors across all eight pages. Done means each page is populated with accurate guidance and runnable examples where possible.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.