Minor docs improvements

[Rel1cx]

What kind of change does this PR introduce?

• Bugfix
• Feature
• Docs
• Test
• New Binding issue #___
• Code style update
• Refactor
• Build-related changes
• Other, please describe:

Does this PR introduce a breaking change?

• Yes, and the changes were approved in issue #___
• No

Checklist

• When resolving issues, they are referenced in the PR's title (e.g fix: remove a typo, closes #___, #___)
• I have added a convincing reason for adding this feature, if necessary

Other information

[vercel]

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

Project	Deployment	Preview	Comments	Updated (UTC)
eslint-react	Ready	Preview	Comment	Dec 6, 2025 8:21am

[Copilot]

Pull request overview

This PR aims to improve documentation formatting across the codebase by standardizing JSDoc comment format. However, the implementation has introduced systematic formatting errors throughout.

Key Changes:

• Attempted to standardize JSDoc @param tag format by removing hyphens between parameter names and descriptions
• Added JSDoc comments to previously undocumented functions in packages/core/src/utils/is-react-api.ts
• Updated generated documentation files to reflect source changes

Reviewed changes

Copilot reviewed 20 out of 20 changed files in this pull request and generated 62 comments.

Show a summary per file

File	Description
packages/utilities/eff/src/index.ts	Updated JSDoc parameter format for multiple utility functions (introduces formatting errors)
packages/utilities/ast/src/function-init-path.ts	Updated JSDoc parameter format for function initialization path utilities (introduces formatting errors)
packages/utilities/ast/src/expression-is.ts	Updated JSDoc parameter format for expression checking function (introduces formatting errors)
packages/utilities/ast/src/expression-base.ts	Updated JSDoc parameter format for expression unwrapping function (introduces formatting errors)
packages/plugins/eslint-plugin-react-x/src/rules/no-string-refs.ts	Updated JSDoc parameter format for helper functions (introduces formatting errors)
packages/plugins/eslint-plugin-react-x/src/rules/no-forward-ref.ts	Updated JSDoc parameter format for helper functions (introduces formatting errors)
packages/plugins/eslint-plugin-react-dom/src/utils/create-jsx-element-resolver.ts	Updated JSDoc parameter format for resolver functions (introduces formatting errors)
packages/plugins/eslint-plugin-react-dom/src/rules/no-unsafe-target-blank.ts	Updated JSDoc parameter format for validation functions (introduces formatting errors)
packages/plugins/eslint-plugin-react-dom/src/rules/no-unknown-property.ts	Updated JSDoc parameter format for multiple helper functions (introduces formatting errors)
packages/core/src/utils/is-react-api.ts	Added documentation for React API checking functions and section comments
packages/core/src/jsx/jsx-stringify.ts	Updated JSDoc parameter format (introduces formatting errors)
packages/core/src/jsx/jsx-hierarchy.ts	Updated JSDoc parameter format (introduces formatting errors)
packages/core/src/jsx/jsx-element-type.ts	Updated JSDoc parameter format (introduces formatting errors)
packages/core/src/jsx/jsx-element-is.ts	Updated JSDoc parameter format (introduces formatting errors)
packages/core/src/component/component-name.ts	Updated JSDoc parameter format (introduces formatting errors)
packages/core/src/component/component-definition.ts	Updated JSDoc parameter format and introduces duplicate @param entries (introduces formatting errors)
packages/core/src/component/component-collector-legacy.ts	Updated JSDoc parameter format and introduces duplicate @param entries (introduces formatting errors)
packages/utilities/eff/docs/*	Generated documentation files with stray asterisks from source formatting errors
packages/core/docs/*	Generated documentation files reflecting source changes

---

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