Skip to content

chore: clean up stale and redundant comments - #91

Merged
tnramalho merged 4 commits into
mainfrom
chore/clean-up-comments
Aug 24, 2026
Merged

chore: clean up stale and redundant comments#91
tnramalho merged 4 commits into
mainfrom
chore/clean-up-comments

Conversation

@leoafarias

Copy link
Copy Markdown
Member

Pull Request

Summary

Removes redundant, stale, and implementation-narrating comments across Rockets core, server auth, tests, and examples while retaining concise rationale where it helps explain behavior.

Changes

  • Delete comments that restate names, types, or nearby implementation.
  • Tighten comments that document persistence, resource, route, and extension-point invariants.
  • Correct stale API references in public JSDoc without changing runtime behavior.

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update
  • Refactoring
  • Dependency update

Verification

  • Build succeeds (yarn build)
  • Unit tests pass (yarn test)
  • E2E tests pass (yarn test:e2e) — aggregate run had one unrelated 404 in create-server.e2e-spec.ts; the exact spec passes alone (3/3)
  • Lint passes (yarn lint)
  • Public API reports pass (yarn api:report:check-built)
  • Spec typecheck passes (yarn typecheck:spec)

Checklist

  • My code follows the existing patterns in the codebase
  • I have updated relevant documentation
  • I have added tests for new functionality

@leoafarias
leoafarias marked this pull request as ready for review August 21, 2026 20:56
Co-authored-by: Cursor <cursoragent@cursor.com>

/**
* Persistence configuration passed on `RocketsAuthOptionsExtrasInterface`.
* Persistence for {@link DefineRocketsAuthInput.persistence}.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This link does not resolve in TypeDoc: DefineRocketsAuthInput.persistence. Use plain text for .persistence, or link only DefineRocketsAuthInput and name the property outside the link.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Fixed in c95df1b: the link now targets DefineRocketsAuthInput and leaves persistence as plain property text. Verified the specific TypeDoc warning is gone.

@tnramalho
tnramalho merged commit cbff168 into main Aug 24, 2026
2 checks passed
@tnramalho
tnramalho deleted the chore/clean-up-comments branch August 24, 2026 12:34
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