kayg/calternal

Watch

Fork 0

DOCS: use domain terms in Money comments #916

New issue

Open

opened 2026-10-02 17:39:59 +00:00 by kayg · 2 comments

kayg commented

2026-10-02 17:39:59 +00:00

Owner

Evidence

At the #863 audit base, a case-sensitive scan found 3 comment lines in 2 files under crates/calternal-money/src that name a third-party budgeting product. Examples: budget.rs:6 and :29 use the product name to describe funding; edit.rs:31 uses its payment-category label.

Owner rule

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

Expected behaviour

Describe the funding and payment-category behavior in calternal terms. Keep the data model and labels unchanged unless the product issue separately changes them.

Test idea

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

## Evidence At the #863 audit base, a case-sensitive scan found 3 comment lines in 2 files under `crates/calternal-money/src` that name a third-party budgeting product. Examples: `budget.rs:6` and `:29` use the product name to describe funding; `edit.rs:31` uses its payment-category label. ## Owner rule Comments are documentation. Source comments must not name third-party products. ## Expected behaviour Describe the funding and payment-category behavior in calternal terms. Keep the data model and labels unchanged unless the product issue separately changes them. ## Test idea Run a source scan for product names. Review the comments against the existing Money model tests without changing their expectations.

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:52:06 +00:00

Author

Owner

Fixed the Rust comment findings in crates/calternal-money. Describe funding states with calternal money terms. Read the affected implementation and kept executable code, protocol values, and test expectations unchanged.

Commit: 24bd2a840b278b2f420e70ded9624835d1b75456.

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/calternal-money/src/budget.rs
crates/calternal-money/src/edit.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/calternal-money`. Describe funding states with calternal money terms. Read the affected implementation and kept executable code, protocol values, and test expectations unchanged. Commit: `24bd2a840b278b2f420e70ded9624835d1b75456`. 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/calternal-money/src/budget.rs` - `crates/calternal-money/src/edit.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 funding states with calternal Money terms (#916)

kayg commented

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

Author

Owner

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

docs: describe funding states with calternal Money terms (#916)

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/calternal-money/src/budget.rs
crates/calternal-money/src/edit.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: `5e0d7b29fcb630453912ca59105af012b83dd174`. This is the retained atomic commit after the final prose review; it supersedes any earlier SHA posted for this work. docs: describe funding states with calternal Money terms (#916) 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/calternal-money/src/budget.rs` - `crates/calternal-money/src/edit.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 funding states with calternal Money terms (#916)

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#916

No description provided.

Rows
Columns