DOCS: add missing Photos module comments and remove product names #933

New issue

Open

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

kayg commented

2026-10-02 17:41:00 +00:00

Owner

Evidence

At the #863 audit base, crates/plugins/photos/src/pairing.rs:1, migration_tests.rs:1, and settings_tests.rs:1 have no leading module comment. pairing.rs holds the Photo grouping rules.
A case-sensitive scan found two comment lines in index.rs:2283-2284 that name a third-party photo product.

Owner rule

Comments are documentation. Each module needs a short, current comment. Source comments must not name third-party products.

Expected behaviour

Explain the grouping module and the purpose of the migration and Settings regression modules. Describe MakerNote field behavior without a vendor name. Keep Photo grouping and metadata behavior unchanged.

Test idea

Run a source scan for module comments and product names. Review the comments against existing Photo tests without changing their expectations.

## Evidence At the #863 audit base, `crates/plugins/photos/src/pairing.rs:1`, `migration_tests.rs:1`, and `settings_tests.rs:1` have no leading module comment. `pairing.rs` holds the Photo grouping rules. A case-sensitive scan found two comment lines in `index.rs:2283-2284` that name a third-party photo product. ## Owner rule Comments are documentation. Each module needs a short, current comment. Source comments must not name third-party products. ## Expected behaviour Explain the grouping module and the purpose of the migration and Settings regression modules. Describe MakerNote field behavior without a vendor name. Keep Photo grouping and metadata behavior unchanged. ## Test idea Run a source scan for module comments and product names. Review the comments against existing Photo 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:57:10 +00:00

Author

Owner

Fixed the Rust comment findings in crates/plugins/photos. Document current photos regression modules and makernote format. Read the affected implementation and kept executable code, protocol values, and test expectations unchanged.

Commit: 6aa1377ae95fe7ee22d259d717b8931ff5670668.

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/photos/src/index.rs
crates/plugins/photos/src/migration_tests.rs
crates/plugins/photos/src/pairing.rs
crates/plugins/photos/src/settings_tests.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/photos`. Document current photos regression modules and makernote format. Read the affected implementation and kept executable code, protocol values, and test expectations unchanged. Commit: `6aa1377ae95fe7ee22d259d717b8931ff5670668`. 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/photos/src/index.rs` - `crates/plugins/photos/src/migration_tests.rs` - `crates/plugins/photos/src/pairing.rs` - `crates/plugins/photos/src/settings_tests.rs` Decision: use protocol, format, and calternal domain terms in place of product names. No behavior decision. Issues remain open.

kayg commented

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

Author

Owner

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

docs: document current Photos regression modules and MakerNote format (#933)

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/photos/src/index.rs
crates/plugins/photos/src/migration_tests.rs
crates/plugins/photos/src/pairing.rs
crates/plugins/photos/src/settings_tests.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: `7eee92a9b79a44b5d7d09dcc95416d9ca711e8a8`. This is the retained atomic commit after the final prose review; it supersedes any earlier SHA posted for this work. docs: document current Photos regression modules and MakerNote format (#933) 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/photos/src/index.rs` - `crates/plugins/photos/src/migration_tests.rs` - `crates/plugins/photos/src/pairing.rs` - `crates/plugins/photos/src/settings_tests.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: document current Photos regression modules and MakerNote format (#933)

kayg referenced this issue

2026-10-03 00:35:56 +00:00

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

kayg referenced this issue

2026-10-03 00:35:56 +00:00

DOCS: remove product names from AI provider comments #923