kayg/calternal

Watch

Fork 0

DOCS: remove product names from IMAP compatibility comments #915

New issue

Open

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

kayg commented

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

Owner

Evidence

At the #863 audit base, a case-sensitive scan found 25 comment lines in 6 files under crates/calternal-imap/src that name common third-party products. Examples: session.rs:1 describes captured Apple SELECT/FETCH behavior; :512 and :580 name product-specific compatibility cases.

Owner rule

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

Expected behaviour

Describe the accepted IMAP grammar, inert extension handling, and UID replacement rules in protocol and state terms. Keep the compatibility behavior unchanged.

Test idea

Run a source scan for product names and review comments against the existing IMAP protocol tests. Do not change parser expectations.

## Evidence At the #863 audit base, a case-sensitive scan found 25 comment lines in 6 files under `crates/calternal-imap/src` that name common third-party products. Examples: `session.rs:1` describes captured Apple SELECT/FETCH behavior; `:512` and `:580` name product-specific compatibility cases. ## Owner rule Comments are documentation. Source comments must not name third-party products. ## Expected behaviour Describe the accepted IMAP grammar, inert extension handling, and UID replacement rules in protocol and state terms. Keep the compatibility behavior unchanged. ## Test idea Run a source scan for product names and review comments against the existing IMAP protocol tests. Do not change parser 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:01 +00:00

Author

Owner

Fixed the Rust comment findings in crates/calternal-imap. Describe imap compatibility and revision evidence in protocol terms. Read the affected implementation and kept executable code, protocol values, and test expectations unchanged.

Commit: fecbf59641859943ebb30ca2aa5809de32e04eee.

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-imap/src/lib.rs
crates/calternal-imap/src/mime.rs
crates/calternal-imap/src/projection.rs
crates/calternal-imap/src/session.rs
crates/calternal-imap/src/store.rs
crates/calternal-imap/src/submission.rs
crates/calternal-imap/src/wire.rs
crates/calternal-imap/tests/mime.rs
crates/calternal-imap/tests/projection.rs
crates/calternal-imap/tests/session.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-imap`. Describe imap compatibility and revision evidence in protocol terms. Read the affected implementation and kept executable code, protocol values, and test expectations unchanged. Commit: `fecbf59641859943ebb30ca2aa5809de32e04eee`. 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-imap/src/lib.rs` - `crates/calternal-imap/src/mime.rs` - `crates/calternal-imap/src/projection.rs` - `crates/calternal-imap/src/session.rs` - `crates/calternal-imap/src/store.rs` - `crates/calternal-imap/src/submission.rs` - `crates/calternal-imap/src/wire.rs` - `crates/calternal-imap/tests/mime.rs` - `crates/calternal-imap/tests/projection.rs` - `crates/calternal-imap/tests/session.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 IMAP compatibility and revision evidence in protocol terms (#915)

kayg commented

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

Author

Owner

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

docs: describe IMAP compatibility and revision evidence in protocol terms (#915)

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-imap/src/lib.rs
crates/calternal-imap/src/mime.rs
crates/calternal-imap/src/projection.rs
crates/calternal-imap/src/session.rs
crates/calternal-imap/src/store.rs
crates/calternal-imap/src/submission.rs
crates/calternal-imap/src/wire.rs
crates/calternal-imap/tests/mime.rs
crates/calternal-imap/tests/projection.rs
crates/calternal-imap/tests/session.rs
crates/calternal-imap/tests/wire.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: `c64c1fa44be7cee2c572cc6b9a68899ba0a031c0`. This is the retained atomic commit after the final prose review; it supersedes any earlier SHA posted for this work. docs: describe IMAP compatibility and revision evidence in protocol terms (#915) 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-imap/src/lib.rs` - `crates/calternal-imap/src/mime.rs` - `crates/calternal-imap/src/projection.rs` - `crates/calternal-imap/src/session.rs` - `crates/calternal-imap/src/store.rs` - `crates/calternal-imap/src/submission.rs` - `crates/calternal-imap/src/wire.rs` - `crates/calternal-imap/tests/mime.rs` - `crates/calternal-imap/tests/projection.rs` - `crates/calternal-imap/tests/session.rs` - `crates/calternal-imap/tests/wire.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 IMAP compatibility and revision evidence in protocol terms (#915)

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

No description provided.

Rows
Columns