docs(users): document all undocumented fields in user request/response models#95
Merged
Merged
Conversation
…e models Closes the 21 missing-docs errors in src/users.rs. Now every field on AccountUserUpdateRequest, AccountUsers, AccountUserOptions, the local TaskStateUpdate copy, and AccountUser carries a brief description. Highlights: - user_id on update request: 'server-populated from path' pattern consistent with the other update-request structs in the crate. - command_type on update: read-only response field with an example operation type, matching the convention applied in cloud_accounts/acl/connectivity update requests. - AccountUserOptions: documents the four notification/access flags (billing, email_alerts, operational_emails, mfa_enabled) so callers know what each toggle controls. - AccountUser: documents the eight user-record fields (id/name/email /role/sign_up/user_type/has_api_key/options) with realistic examples for the enum-like string fields. - The local TaskStateUpdate copy is doc-noted as a duplicate of crate::types::TaskStateUpdate, with a pointer to #64 for the canonical-type consolidation. Strict-lint missing-docs error count drops by 21 (302 → 281 on main). After this and #94 merge, all remaining errors are concentrated in the four large request/response modules (fixed/databases, fixed/subscriptions, flexible/databases, flexible/subscriptions). Refs #80 (rustdoc umbrella — P0 missing-docs slice for users.rs) Refs #64 (canonical task type)
4 tasks
This was referenced May 19, 2026
joshrotenberg
added a commit
that referenced
this pull request
May 19, 2026
…nks (#98) All 368 missing-docs errors surfaced by the 2026-05 review are now closed across the cloud crate (#90, #91, #92, #93, #94, #95, #96). This commit promotes those lints to compile errors so the bar cannot regress without a deliberate decision. - Adds #![deny(missing_docs)] to lib.rs — every public item must carry a docstring. - Adds #![deny(rustdoc::broken_intra_doc_links)] — the intra-doc links added throughout the rustdoc pass (TaskStateUpdate ↔ TaskStatus, ConnectivityHandler delegation pointers, etc.) stay valid going forward. No source-level behavior changes. cargo fmt, cargo clippy --workspace --all-targets -- -D warnings, cargo test --workspace, and cargo doc --no-deps all pass. Closes #80
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
1 participant
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.
Summary
Closes the 21 missing-docs errors in
src/users.rs. Every field onAccountUserUpdateRequest,AccountUsers,AccountUserOptions, the localTaskStateUpdatecopy, andAccountUsernow carries a brief description.Highlights
user_idon update request: "server-populated from path" pattern, consistent with the other update-request structs in docs(small modules): document the remaining undocumented fields in 6 short modules #94 (cloud_accounts/acl/connectivity).command_typeon update: read-only response field, same convention.AccountUserOptions: docs for the four notification/access flags (billing, email_alerts, operational_emails, mfa_enabled).AccountUser: docs for the eight user-record fields (id/name/email/role/sign_up/user_type/has_api_key/options) with realistic examples for the enum-like string fields.TaskStateUpdatecopy now carries a pointer to refactor(types): consolidate shared task/tag/link models and normalize task status typing #64 for the canonical-type consolidation.Net effect on #80 progress
Strict-lint missing-docs errors drop by 21. After this and #94 merge, remaining errors are concentrated in the four large request/response modules:
src/fixed/databases.rssrc/fixed/subscriptions.rssrc/flexible/databases.rssrc/flexible/subscriptions.rsThose ship as the next set of PRs.
Test plan
cargo fmt --all -- --checkcargo clippy --workspace --all-targets -- -D warningscargo test --workspace— all pass; 72 doctestsRefs #80, #64