Skip to content

Comments

chore: remove unnecessary @public annotations and guidelines#1595

Merged
danielroe merged 1 commit intomainfrom
chore/remove-public-jsdoc
Feb 23, 2026
Merged

chore: remove unnecessary @public annotations and guidelines#1595
danielroe merged 1 commit intomainfrom
chore/remove-public-jsdoc

Conversation

@serhalp
Copy link
Member

@serhalp serhalp commented Feb 23, 2026

🔗 Linked issue

N/A - cleanup

🧭 Context

Previously, knip didn't understand nuxt auto-imports, so we used @public jsdoc annotations as some sort of funny workaround

knip supports this now; so this is an outdated guideline

📚 Description

  • Remove guideline about this
  • Clean up some remaining uses of this pattern

knip supports this now; this is outdated information
@vercel
Copy link

vercel bot commented Feb 23, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
npmx.dev Ready Ready Preview, Comment Feb 23, 2026 3:50am
2 Skipped Deployments
Project Deployment Actions Updated (UTC)
docs.npmx.dev Ignored Ignored Feb 23, 2026 3:50am
npmx-lunaria Ignored Ignored Feb 23, 2026 3:50am

Request Review

@codecov
Copy link

codecov bot commented Feb 23, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

@serhalp serhalp marked this pull request as ready for review February 23, 2026 03:53
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 23, 2026

No actionable comments were generated in the recent review. 🎉


📝 Walkthrough

Walkthrough

This PR removes @public JSDoc annotations from numerous exported functions, types, and constants across the codebase, and deletes documentation instructions about annotating auto-imported exports with @public. The function signatures, type declarations, and runtime behaviour remain unchanged; only documentation metadata is affected.

Possibly related PRs

Suggested reviewers

  • danielroe
🚥 Pre-merge checks | ✅ 1
✅ Passed checks (1 passed)
Check name Status Explanation
Description check ✅ Passed The pull request description clearly explains the purpose of removing @public annotations and the rationale—knip now supports Nuxt auto-imports, making the workaround outdated.

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

✨ Finishing Touches
  • 📝 Generate docstrings (stacked PR)
  • 📝 Generate docstrings (commit on current branch)
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch chore/remove-public-jsdoc

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@serhalp serhalp requested a review from danielroe February 23, 2026 13:18
@danielroe danielroe added this pull request to the merge queue Feb 23, 2026
Merged via the queue into main with commit c9e9821 Feb 23, 2026
20 checks passed
@danielroe danielroe deleted the chore/remove-public-jsdoc branch February 23, 2026 13:23
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