rados: Improve documentation for NewConnWith APIs#1218
Merged
Conversation
phlogistonjohn
requested changes
Jan 8, 2026
d097d2d to
cb1b23b
Compare
NewConnWithUser() and NewConnWithClusterAndUser() bindings require the username in a format that matches the expectations of their respective underlying C APIs, rados_create() and rados_create2(). Clarify this requirement in the documentation comments so the expected format is unambiguous. Signed-off-by: Anoop C S <anoopcs@cryptolab.net>
cb1b23b to
61729ae
Compare
phlogistonjohn
approved these changes
Jan 8, 2026
Contributor
Merge Queue Status✅ The pull request has been merged at 61729ae This pull request spent 7 seconds in the queue, with no time running CI. Required conditions to merge
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
NewConnWithUser() andNewConnWithClusterAndUser()bindings require the username in a format that matches the expectations of their respective underlying C APIs, rados_create() and rados_create2(). Clarify this requirement in the documentation comments so the expected format is unambiguous.fixes #244