kayg/calternal

Watch

Fork 0

DOCS: use domain terms in the Money plugin comments #931

New issue

Open

opened 2026-10-02 17:40:54 +00:00 by kayg · 3 comments

kayg commented

2026-10-02 17:40:54 +00:00

Owner

Evidence

At the #863 audit base, a case-sensitive scan found five comment lines in four files under crates/plugins/money/src that name common third-party budgeting products. Examples: lib.rs:3-4 names two products; views.rs:70,127 uses one product's state and category labels.

Owner rule

Comments are documentation. Source comments must not name third-party products.

Expected behaviour

Describe the budget model and UI state in calternal terms. Keep the current domain behavior and labels unchanged unless another issue changes them.

Test idea

Run a source scan for product names. Review comments against existing Money model and route tests without changing their expectations.

## Evidence At the #863 audit base, a case-sensitive scan found five comment lines in four files under `crates/plugins/money/src` that name common third-party budgeting products. Examples: `lib.rs:3-4` names two products; `views.rs:70,127` uses one product's state and category labels. ## Owner rule Comments are documentation. Source comments must not name third-party products. ## Expected behaviour Describe the budget model and UI state in calternal terms. Keep the current domain behavior and labels unchanged unless another issue changes them. ## Test idea Run a source scan for product names. Review comments against existing Money model and route tests without changing their expectations.

kayg commented

2026-10-02 17:42:29 +00:00

Author

Owner

Correction to Evidence: the scan matched five comment lines in three files, not four. The files are lib.rs, routes.rs, and views.rs.

Correction to Evidence: the scan matched five comment lines in three files, not four. The files are `lib.rs`, `routes.rs`, and `views.rs`.

kayg referenced this issue

2026-10-02 17:44:36 +00:00

Audit: module docs and stale comments (comments are docs) #863

kayg commented

2026-10-02 17:56:05 +00:00

Author

Owner

Fixed the Rust comment findings in crates/plugins/money. Describe category funding and ready to assign in domain terms. Read the affected implementation and kept executable code, protocol values, and test expectations unchanged.

Commit: dd98df22988385ac21400f36e9809612f9856e19.

Verification: cargo fmt --check exited 0; output was empty. A source comparison with full-line comments removed matched before and after for every changed file.

Files:

crates/plugins/money/src/lib.rs
crates/plugins/money/src/routes.rs
crates/plugins/money/src/views.rs

Decision: use protocol, format, and calternal domain terms in place of product names. No behavior decision. Issues remain open.

Fixed the Rust comment findings in `crates/plugins/money`. Describe category funding and ready to assign in domain terms. Read the affected implementation and kept executable code, protocol values, and test expectations unchanged. Commit: `dd98df22988385ac21400f36e9809612f9856e19`. Verification: `cargo fmt --check` exited 0; output was empty. A source comparison with full-line comments removed matched before and after for every changed file. Files: - `crates/plugins/money/src/lib.rs` - `crates/plugins/money/src/routes.rs` - `crates/plugins/money/src/views.rs` Decision: use protocol, format, and calternal domain terms in place of product names. No behavior decision. Issues remain open.

kayg referenced this issue from a commit

2026-10-02 17:56:13 +00:00

docs: describe Category funding and Ready to Assign in domain terms (#931)

kayg commented

2026-10-02 18:02:40 +00:00

Author

Owner

Rust comment fixes are complete on job/docsfix-rust. Final commit: c9643b1b14751957ca26a3ba81d510d7c92bbcdb. This is the retained atomic commit after the final prose review; it supersedes any earlier SHA posted for this work.

docs: describe Category funding and Ready to Assign in domain terms (#931)

All executable source and test expectations are unchanged. The final comparison against origin/dev confirmed only full-line comments and blank lines changed. The audited product-name scan passed across non-vendored Rust comments.

Gate: cargo fmt --check exited 0. Verbatim stdout and stderr are empty:

Files:

crates/plugins/money/src/lib.rs
crates/plugins/money/src/routes.rs
crates/plugins/money/src/views.rs

Decision: describe existing behavior with protocol, format, and calternal domain terms; no behavior or design change. No build or behavior tests ran, as required by this comment-only job. No issue is closed.

Rust comment fixes are complete on `job/docsfix-rust`. Final commit: `c9643b1b14751957ca26a3ba81d510d7c92bbcdb`. This is the retained atomic commit after the final prose review; it supersedes any earlier SHA posted for this work. docs: describe Category funding and Ready to Assign in domain terms (#931) All executable source and test expectations are unchanged. The final comparison against `origin/dev` confirmed only full-line comments and blank lines changed. The audited product-name scan passed across non-vendored Rust comments. Gate: `cargo fmt --check` exited 0. Verbatim stdout and stderr are empty: ```text ``` Files: - `crates/plugins/money/src/lib.rs` - `crates/plugins/money/src/routes.rs` - `crates/plugins/money/src/views.rs` Decision: describe existing behavior with protocol, format, and calternal domain terms; no behavior or design change. No build or behavior tests ran, as required by this comment-only job. No issue is closed.

kayg referenced this issue

2026-10-02 18:02:42 +00:00

Audit: module docs and stale comments (comments are docs) #863

kayg referenced this issue from a commit

2026-10-02 18:10:46 +00:00

docs: describe Category funding and Ready to Assign in domain terms (#931)

No labels

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference

kayg/calternal#931

No description provided.

Rows
Columns