fix(NATSRS-009-2): CU-86akbhh82 Public Auth struct and constructor lack doc comments - #138
Draft
flamingo[bot] wants to merge 1 commit into
Draft
flamingo[bot] wants to merge 1 commit into
flamingo[bot] wants to merge 1 commit into
Conversation
| /// This can include a JWT, an NKey, a signature callback, or simple | ||
| /// username/password or token credentials, depending on how the server is | ||
| /// configured to authenticate clients. | ||
| #[derive(Default)] |
Author
There was a problem hiding this comment.
🦩 🟠 Public Auth struct and constructor lack doc comments
Added /// doc comments to the Auth struct, its public fields (jwt, nkey, signature, username, password, token), and Auth::new() in async-nats/src/auth.rs. The private signature_callback field was left undocumented as it is not pub and thus outside the scope of NATSRS-009-2.
🤖 Prompt for AI agents
In async-nats/src/auth.rs around line 3, review and complete this code-review fix: Public Auth struct and constructor lack doc comments.
What the draft fix changed: Added `///` doc comments to the `Auth` struct, its public fields (`jwt`, `nkey`, `signature`, `username`, `password`, `token`), and `Auth::new()` in `async-nats/src/auth.rs`. The private `signature_callback` field was left undocumented as it is not `pub` and thus outside the scope of NATSRS-009-2.
Verify the change is correct and complete; do not refactor unrelated code.
fix confidence: 🟢 90 high — react 👍/👎 to teach the reviewer
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
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.
Closes findings from rule NATSRS-009-2 — Public Auth struct and constructor lack doc comments.
Draft — this is a starting point, not a finished change. The fix required judgment, so read it before trusting it.
async-nats/src/auth.rs:3What changed — and what was deliberately left — is explained per finding as inline review comments on the lines each finding touched.
Run: https://product-hub.flamingo.so/admin/code-review
Run id:
4fa2224e-8528-443d-a51a-823c78308977Merging this PR is recorded as acceptance of the rule that produced it;
closing it unmerged is recorded as rejection. Both feed rule health, so
closing a wrong suggestion is useful rather than merely tidy.
ClickUp task: CU-86akbhh82 NATS async-nats and CI review findings (9 PRs)