kayg/calternal

Watch

Fork 0

DOCS: remove product names from Files plugin comments #929

New issue

Open

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

kayg commented

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

Owner

Evidence

At the #863 audit base, a case-sensitive scan found 9 comment lines in 4 files under crates/plugins/files/src that name common third-party products. Examples: lib.rs:119 and :1290 name an external photo source; public.rs:771 names three link-unfurling clients.

Owner rule

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

Expected behaviour

Describe photo import metadata and link-unfurl behavior without vendor names. Preserve protocol fields, sidecar behavior, and displayed output.

Test idea

Run a source scan for product names. Review the affected comments against existing Files and public-share tests. Do not change response fields or test expectations.

## Evidence At the #863 audit base, a case-sensitive scan found 9 comment lines in 4 files under `crates/plugins/files/src` that name common third-party products. Examples: `lib.rs:119` and `:1290` name an external photo source; `public.rs:771` names three link-unfurling clients. ## Owner rule Comments are documentation. Source comments must not name third-party products. ## Expected behaviour Describe photo import metadata and link-unfurl behavior without vendor names. Preserve protocol fields, sidecar behavior, and displayed output. ## Test idea Run a source scan for product names. Review the affected comments against existing Files and public-share tests. Do not change response fields or test 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:55:50 +00:00

Author

Owner

Fixed the Rust comment findings in crates/plugins/files. Describe sidecars and anonymous link previews without product names. Read the affected implementation and kept executable code, protocol values, and test expectations unchanged.

Commit: 9f69bfb55fb6b79794699f6e0f6724f1dce59442.

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/files/src/lib.rs
crates/plugins/files/src/preferences.rs
crates/plugins/files/src/public.rs
crates/plugins/files/src/user_bytes.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/files`. Describe sidecars and anonymous link previews without product names. Read the affected implementation and kept executable code, protocol values, and test expectations unchanged. Commit: `9f69bfb55fb6b79794699f6e0f6724f1dce59442`. 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/files/src/lib.rs` - `crates/plugins/files/src/preferences.rs` - `crates/plugins/files/src/public.rs` - `crates/plugins/files/src/user_bytes.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 Sidecars and anonymous link previews without product names (#929)

kayg commented

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

Author

Owner

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

docs: describe Sidecars and anonymous link previews without product names (#929)

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/files/src/lib.rs
crates/plugins/files/src/preferences.rs
crates/plugins/files/src/public.rs
crates/plugins/files/src/user_bytes.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: `df586c2de8cbffa259d7e0413e12fa93e9a9c81c`. This is the retained atomic commit after the final prose review; it supersedes any earlier SHA posted for this work. docs: describe Sidecars and anonymous link previews without product names (#929) 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/files/src/lib.rs` - `crates/plugins/files/src/preferences.rs` - `crates/plugins/files/src/public.rs` - `crates/plugins/files/src/user_bytes.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 Sidecars and anonymous link previews without product names (#929)

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

kayg commented

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

Author

Owner

Repair on job/docsfix-rust (not pushed): 3c0ff64e2 docs(rust): restore client, platform and library names in comments.

Clarified rule (owner, 2026-10-02): do not name competing apps (other notes, calendar, mail or photo apps) in UI, code or comments. Platform, OS, browser, protocol, client and library names that state technical facts stay.

The scrub turned interop facts into vague stand-ins ("Apple Calendar uses a dashed UUID" became "Some CalDAV clients", "Safari on iOS" became "A mobile browser", "Finder" became "file manager") and added a stray "The" to continuation lines. This commit restores Apple Calendar, Reminders, Apple Notes (IMAP), macOS 27, dataaccessd, the #356 and #428 macOS VM and Mac run notes, Finder, Safari, Chromium, iOS, Mac, Fastmail, Aside, Claude Desktop, Claude Code and Codex CLI (AgentProvider docs), Unsplash, ProseMirror, Slack, WhatsApp, iMessage, Google feed import rules and Apple MakerNote. The AAE sidecar spelling is now "the iOS and macOS spelling".

Kept: the stale-comment fixes from #920, #928, #929, #932 and #933, the version-thinning precision fix and the "Credit Card Payments" / "Inflow: Ready to Assign" names. Competing apps stay unnamed: Obsidian (Tasks), Lightroom, YNAB, Actual Budget and Nextcloud (version thinning).

Gate: cargo fmt --check: clean (exit 0). Comments only.

Repair on `job/docsfix-rust` (not pushed): `3c0ff64e2` docs(rust): restore client, platform and library names in comments. Clarified rule (owner, 2026-10-02): do not name competing apps (other notes, calendar, mail or photo apps) in UI, code or comments. Platform, OS, browser, protocol, client and library names that state technical facts stay. The scrub turned interop facts into vague stand-ins ("Apple Calendar uses a dashed UUID" became "Some CalDAV clients", "Safari on iOS" became "A mobile browser", "Finder" became "file manager") and added a stray "The" to continuation lines. This commit restores Apple Calendar, Reminders, Apple Notes (IMAP), macOS 27, dataaccessd, the #356 and #428 macOS VM and Mac run notes, Finder, Safari, Chromium, iOS, Mac, Fastmail, Aside, Claude Desktop, Claude Code and Codex CLI (`AgentProvider` docs), Unsplash, ProseMirror, Slack, WhatsApp, iMessage, Google feed import rules and Apple MakerNote. The AAE sidecar spelling is now "the iOS and macOS spelling". Kept: the stale-comment fixes from #920, #928, #929, #932 and #933, the version-thinning precision fix and the "Credit Card Payments" / "Inflow: Ready to Assign" names. Competing apps stay unnamed: Obsidian (Tasks), Lightroom, YNAB, Actual Budget and Nextcloud (version thinning). Gate: `cargo fmt --check`: clean (exit 0). Comments only.

kayg referenced this issue from a commit

2026-10-03 00:40:49 +00:00

docs(rust): restore client, platform and library names in comments

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

No description provided.

Rows
Columns