Skip to content

chore: updating comments across package#76

Merged
drduhe merged 1 commit intomainfrom
chore/update-comments
Feb 13, 2026
Merged

chore: updating comments across package#76
drduhe merged 1 commit intomainfrom
chore/update-comments

Conversation

@drduhe
Copy link
Copy Markdown
Collaborator

@drduhe drduhe commented Feb 13, 2026

Issue #, if available: n/a

Standardize comment structure across the codebase

Summary

  • Establishes and applies a consistent comment standard across all 41 source files (TypeScript, Python, and config)
  • Adds a Cursor rule (.cursor/rules/comment-standards.mdc) so the standard is enforced in future AI-assisted edits

What changed

  • Module docstrings: Every file now has a JSDoc (/** */) or Python docstring (""") immediately after the copyright header describing its purpose
  • Exported function docs: All exported functions use TSDoc-style @param/@returns (removed legacy {Type} syntax from s3Helper, sagemakerHelper, imageryProviders)
  • Internal function docs: Concise single-line JSDoc on private helpers
  • Exported type/interface docs: Brief JSDoc on all public interfaces (types.ts, ResourceContext.tsx, modelRunnerHelper.ts, etc.)
  • Section dividers: Normalized to /* ── Title ── */ style (ImageRequestModal.tsx)
  • TODO format: Converted /** TODO */ blocks to // TODO: line comments (s3Helper.ts)
  • Entry point cleanup: Replaced @file/@description JSDoc tags in main.tsx with a clean module docstring
  • Copyright headers: Added missing headers to all electron/ files and vite.config.ts

Files affected

Area Files Changes
Cursor rule 1 New .cursor/rules/comment-standards.mdc
src/utils/ 7 Module docstrings, TSDoc params, interface docs
src/components/ 14 Module docstrings
src/context/ 1 Module docstring, interface docs
src/__tests__/ 4 Module docstrings
src/ root 4 Module docstrings, main.tsx cleanup
electron/ 4 Copyright headers, module docstrings
scripts/ 1 Python module docstring
Root configs 2 Copyright headers, module docstrings

Risk

Zero functional changes — comments and documentation only.

Checklist

Before you submit a pull request, please make sure you have the following:

  • Code changes are compact and well-structured to facilitate easy review
  • Changes are documented in the README.md and other relevant documentation pages
  • PR title and description accurately reflect the changes and are detailed enough for historical tracking
  • PR contains tests that cover all new code and the code has been manual tested
  • All new dependencies are declared (if any), and no unnecessary libraries are added
  • Performance impacts (if any) of the changes are evaluated and documented
  • Security implications of the changes (if any) are reviewed and addressed
  • I have read the Contributing Guidelines and agree to follow the Code of Conduct

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Copy link
Copy Markdown

@devinglauner devinglauner left a comment

Choose a reason for hiding this comment

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

LGTM

@drduhe drduhe merged commit ec9fb19 into main Feb 13, 2026
4 checks passed
@drduhe drduhe deleted the chore/update-comments branch February 25, 2026 18:12
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.

2 participants