Skip to content

Add missing JSDoc to ReadonlySet and ReadonlyMap members#63508

Open
TxsharDev wants to merge 1 commit into
microsoft:mainfrom
TxsharDev:fix/readonly-set-map-jsdoc
Open

Add missing JSDoc to ReadonlySet and ReadonlyMap members#63508
TxsharDev wants to merge 1 commit into
microsoft:mainfrom
TxsharDev:fix/readonly-set-map-jsdoc

Conversation

@TxsharDev
Copy link
Copy Markdown

@TxsharDev TxsharDev commented May 27, 2026 •
edited
Loading

ReadonlySet and ReadonlyMap in es2015.collection.d.ts are missing JSDoc on their members. The mutable counterparts (Set, Map) have full documentation but the readonly versions have none.

This adds matching JSDoc to:

  • ReadonlySet<T> · forEach, has, size
  • ReadonlyMap<K, V> · forEach, get, has, size

Docs are consistent with the existing comments on Set<T> and Map<K, V>.

Fixes #63481

Copilot AI review requested due to automatic review settings May 27, 2026 15:52
@github-project-automation github-project-automation Bot moved this to Not started in PR Backlog May 27, 2026
@typescript-bot typescript-bot added the For Uncommitted Bug PR for untriaged, rejected, closed or missing bug label May 27, 2026
@typescript-bot
Copy link
Copy Markdown
Collaborator

typescript-bot commented May 27, 2026

This PR doesn't have any linked issues. Please open an issue that references this PR. From there we can discuss and prioritise.

1 similar comment
@typescript-bot
Copy link
Copy Markdown
Collaborator

typescript-bot commented May 27, 2026

This PR doesn't have any linked issues. Please open an issue that references this PR. From there we can discuss and prioritise.

Copilot AI reviewed May 27, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot wasn't able to review any files in this pull request.

@TxsharDev
Copy link
Copy Markdown
Author

TxsharDev commented May 27, 2026

@microsoft-github-policy-service agree

@typescript-bot typescript-bot added For Backlog Bug PRs that fix a backlog bug and removed For Uncommitted Bug PR for untriaged, rejected, closed or missing bug labels May 27, 2026
@MartinJohns
Copy link
Copy Markdown
Contributor

MartinJohns commented May 27, 2026 •
edited
Loading

Why another one? There's already #63483 and #63488. Seems to be done by AI.

@TxsharDev
Copy link
Copy Markdown
Author

TxsharDev commented May 27, 2026

@MartinJohns
Thanks for flagging. #63488 is already closed, and #63483 only covers ReadonlySet. This PR also adds JSDoc to ReadonlyMap (forEach, get, has, size) which has the same documentation gap. The docs match the existing Map<K,V> and Set<T> patterns in the same file. Happy to drop the ReadonlySet portion if the maintainers prefer to keep that in #63483. Also, this wasn't AI generated, I wrote the JSDoc by reading the existing Map and Set docs in the same file and matching the style.

@hbrooks hbrooks mentioned this pull request May 28, 2026
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

For Backlog Bug PRs that fix a backlog bug

Projects

PR Backlog
Status: Not started

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

ReadonlySet lacks documentation for has, forEach and size

4 participants

@TxsharDev @typescript-bot @MartinJohns