Skip to content

docs(desktop): remove redundant comments - #5816

Merged
Jocs merged 1 commit into
developfrom
docs/desktop-comments
Oct 21, 2026
Merged

Jocs merged 1 commit into
developfrom
docs/desktop-comments

Conversation

@Jocs

@Jocs Jocs commented Oct 21, 2026 •

Copy link
Copy Markdown
Member

Summary

Apply .github/COMMENTING-GUIDELINES.md across the desktop package. Remove comments that repeat names, statements or assertions, obsolete migration notes and commented-out code; shorten verbose explanations while retaining caller contracts, lifecycle constraints, compatibility reasons and accessibility rationale.

Changes cover main, preload, renderer, shared types, themes, build configuration and tests: 275 files, 2,420 net lines removed. Non-comment code, template structure, CSS declarations, build settings, licenses and tooling directives are unchanged.

No dedicated issue: maintenance cleanup requested during review.

Type of change

  • Documentation update

Test plan

  • Root ESLint: 0 errors; the existing 180 warnings remain.
  • Desktop typecheck.
  • Parsed TypeScript/JavaScript, Vue template/script and CSS comparison against develop; tooling directives checked separately. Installer/build configuration commands and values are unchanged.
  • git diff --check.
  • New runtime tests and visual evidence are not applicable to comment-only changes.

Notes for reviewers

Independent of the sibling unused-binding (#5817) and redundant-assertion (#5818) cleanups; all target develop directly. Keep this PR scoped to comments.


By submitting this pull request, I confirm that my contribution is made under the terms of the MIT license.

@github-actions

Copy link
Copy Markdown
Contributor

Build artifacts for PR #5816:

Run: https://github.com/marktext/marktext/actions/runs/39523094523

Artifact Size Link
marktext-linux-x64 667.3 MB Download
marktext-linux-arm64 522.3 MB Download
marktext-windows-arm64 291.0 MB Download
marktext-macos-arm64 300.2 MB Download
marktext-macos-x64 313.6 MB Download
marktext-windows-x64 299.1 MB Download

@Jocs
Jocs merged commit 396cc70 into develop Oct 21, 2026
13 checks passed
@Jocs
Jocs deleted the docs/desktop-comments branch October 23, 2026 08:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant