Skip to content

docs: jsdocs improvements#632

Merged
exploIF merged 6 commits into
mainfrom
@exploif/jsdocs
Jun 15, 2026
Merged

docs: jsdocs improvements#632
exploIF merged 6 commits into
mainfrom
@exploif/jsdocs

Conversation

@exploIF

@exploIF exploIF commented Jun 9, 2026

Copy link
Copy Markdown
Collaborator

Summary

Adds JSDocs

@exploIF exploIF marked this pull request as ready for review June 15, 2026 10:30
Copilot AI review requested due to automatic review settings June 15, 2026 10:30

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR improves developer-facing documentation by adding/expanding JSDoc comments for the library’s public TypeScript types and component interfaces, helping consumers understand editor props/events and the imperative ref API surface.

Changes:

  • Added JSDoc for TextShortcut / TextShortcutStyle usage and intent.
  • Documented EnrichedTextInputInstance methods and behaviors.
  • Added detailed prop-level JSDoc for EnrichedTextInputProps, EnrichedTextInstance, and EnrichedTextProps.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread src/types.ts Outdated
Comment thread src/types.ts
exploIF and others added 2 commits June 15, 2026 12:36
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Comment thread src/types.ts Outdated
Comment thread src/types.ts Outdated
Comment thread src/types.ts Outdated
Comment thread src/types.ts Outdated
Comment thread src/types.ts Outdated
Comment thread src/types.ts Outdated
@exploIF exploIF merged commit 7ce19e4 into main Jun 15, 2026
7 checks passed
@exploIF exploIF deleted the @exploif/jsdocs branch June 15, 2026 11:35
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.

3 participants