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

session: add docstrings for AddressTranslator #796

Merged
merged 1 commit into from Aug 22, 2023

Conversation

wprzytula
Copy link
Collaborator

Both AddressTranslator trait and address_translator pub field in SessionConfig were missing docstrings. They were added. The docstring for the trait is adapted from Java driver 3.

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.

@wprzytula wprzytula added the documentation Improvements or additions to documentation label Aug 22, 2023
@wprzytula wprzytula requested a review from piodul August 22, 2023 10:23
Copy link
Collaborator

@piodul piodul left a comment

Choose a reason for hiding this comment

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

One nitpick, otherwise LGTM.

scylla/src/transport/session.rs Outdated Show resolved Hide resolved
Both `AddressTranslator` trait and `address_translator` `pub` field in
`SessionConfig` were missing docstrings. They were added. The docstring
for the trait is adapted from Java driver 3.
@piodul piodul merged commit 148595a into scylladb:main Aug 22, 2023
8 checks passed
@wprzytula wprzytula deleted the translator-docstring branch August 23, 2023 07:17
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.

None yet

2 participants