Skip to content

docs: remove stale Tauri platform comments - #97

Merged
Astro-Han merged 1 commit into
devfrom
codex/remove-tauri-comments
Apr 21, 2026
Merged

docs: remove stale Tauri platform comments#97
Astro-Han merged 1 commit into
devfrom
codex/remove-tauri-comments

Conversation

@Astro-Han

@Astro-Han Astro-Han commented Apr 21, 2026

Copy link
Copy Markdown
Owner

Summary

Update stale platform interface comments that still described desktop-only APIs as Tauri-only.

Why

PR #93 removed the functional Tauri compatibility paths. These comments were non-functional keyword residue and could confuse future audits for Tauri cleanup.

Related Issue

Part of #91.

How To Verify

rg -n "Tauri only|native on Tauri|tauri|Tauri" packages/app/src/context/platform.tsx
git diff --check

bun run --cwd packages/app typecheck was attempted from the main checkout, but this checkout does not currently have dependencies installed, so tsgo was unavailable. This change is comments only.

Screenshots or Recordings

Not applicable. Comments only.

Checklist

  • I ran the relevant verification steps
  • I tested visible changes manually when needed
  • I am targeting the dev branch

Summary by CodeRabbit

  • Documentation
    • Updated platform compatibility descriptions for desktop-related features to improve clarity on feature availability across different platforms.

@Astro-Han Astro-Han added documentation Improvements or additions to documentation P3 Low priority app Application behavior and product flows labels Apr 21, 2026
@coderabbitai

coderabbitai Bot commented Apr 21, 2026

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: a8d8b05a-95a9-4027-b028-43cd53eb088b

📥 Commits

Reviewing files that changed from the base of the PR and between 88c70c4 and 675bcf7.

📒 Files selected for processing (1)
  • packages/app/src/context/platform.tsx

📝 Walkthrough

Walkthrough

Updated inline documentation in the Platform type to describe functionality constraints as "desktop only" instead of "Tauri only" for the os field and several optional methods. No code logic, types, or runtime behavior were modified.

Changes

Cohort / File(s) Summary
Documentation Update
packages/app/src/context/platform.tsx
Updated comments for Platform type fields to replace "Tauri only" with "desktop only" for os, openDirectoryPickerDialog, openFilePickerDialog, saveFilePickerDialog, checkUpdate, and update.

Suggested labels

desktop

Poem

🐰 Platform docs now speak clear,
No more Tauri-only fear,
Desktop-bound, the truth rings true,
Comments polished, fresh and new!

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: removing stale Tauri-related comments from the platform module documentation.
Description check ✅ Passed The description follows the template structure with all major sections completed: Summary, Why, Related Issue, How To Verify, Screenshots/Recordings, and Checklist.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/remove-tauri-comments

Comment @coderabbitai help to get the list of available commands and usage tips.

@Astro-Han
Astro-Han merged commit 1a02ca9 into dev Apr 21, 2026
17 checks passed
@Astro-Han
Astro-Han deleted the codex/remove-tauri-comments branch April 21, 2026 12:40

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the JSDoc documentation in the platform context to replace references to "Tauri" with "desktop", ensuring consistency with the platform discriminator types. I have no feedback to provide.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

app Application behavior and product flows documentation Improvements or additions to documentation P3 Low priority

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant