Skip to content
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

book: improve documentation about UDT values #789

Merged
merged 1 commit into from
Aug 21, 2023

Conversation

cvybhu
Copy link
Contributor

@cvybhu cvybhu commented Aug 18, 2023

This change aims to improve the documentation about handling user defined types in the Rust driver.

Changes:

  • Mention that fields in UDT and Rust struct must be in the same order
  • Add a link to official Scylla docs about UDTs
  • Improve grammar, make it clearer

Pre-review checklist

  • I have split my patch into logically separate commits.
  • All commit messages clearly explain what they change and why.
  • I added relevant tests for new features and bug fixes.
  • All commits compile, pass static checks and pass test.
  • PR description sums up the changes and reasons why they should be introduced.
  • I have provided docstrings for the public items that I want to introduce.
  • I have adjusted the documentation in ./docs/source/.
  • I added appropriate Fixes: annotations to PR description.

@cvybhu
Copy link
Contributor Author

cvybhu commented Aug 18, 2023

Here's how the updated page looks like:

image

@cvybhu cvybhu added the area/documentation Improvements or additions to documentation label Aug 18, 2023
This change aims to improve the documentation
about handling user defined types in the Rust driver.

Changes:
* Mention that fields in UDT and Rust struct must be in the same order
* Add a link to official Scylla docs about UDTs
* Improve grammar, make it clearer

Signed-off-by: Jan Ciolek <[email protected]>
@wprzytula wprzytula merged commit 3072269 into scylladb:main Aug 21, 2023
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants