Skip to content

Typo in doc comments for Set.keys and ReadonlySet.keys #40164

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
cherryblossom000 opened this issue Aug 21, 2020 · 1 comment · Fixed by #40176
Closed

Typo in doc comments for Set.keys and ReadonlySet.keys #40164

cherryblossom000 opened this issue Aug 21, 2020 · 1 comment · Fixed by #40176
Labels
Domain: lib.d.ts The issue relates to the different libraries shipped with TypeScript Good First Issue Well scoped, documented and has the green light Help Wanted You can do this

Comments

@cherryblossom000
Copy link
Contributor

TypeScript Version: 4.0.2

Search Terms: typo lib Set ReadonlySet keys

Code

const set = new Set()
set.keys()
;(set as ReadonlySet<unknown>).keys()

Expected behavior:

Documentation for Set.keys and ReadonlySet.keys should be

Despite its name, returns an iterable of the values in the set.

(full stop/period at the end)

Actual behavior:

Despite its name, returns an iterable of the values in the set,

(comma at the end)

Playground Link: link

Related Issues:

@DanielRosenwasser DanielRosenwasser added Domain: lib.d.ts The issue relates to the different libraries shipped with TypeScript Good First Issue Well scoped, documented and has the green light Help Wanted You can do this labels Aug 21, 2020
@DanielRosenwasser
Copy link
Member

Should just be a matter of changing the comments in src/lib

@cherryblossom000 cherryblossom000 mentioned this issue Aug 21, 2020
Merged
RyanCavanaugh pushed a commit that referenced this issue Aug 21, 2020
@cherryblossom000
Fix typo in (Readonly)Set.keys comment (fixes #40164) (#40176)
e8dbc2d
Kingwl pushed a commit to Kingwl/TypeScript that referenced this issue Aug 24, 2020
@cherryblossom000 @Kingwl
Fix typo in (Readonly)Set.keys comment (fixes microsoft#40164) (micro…
6a75377 
…soft#40176)
Kingwl pushed a commit to Kingwl/TypeScript that referenced this issue Aug 24, 2020
@cherryblossom000 @Kingwl
Fix typo in (Readonly)Set.keys comment (fixes microsoft#40164) (micro…
80326ba 
…soft#40176)
sandersn pushed a commit that referenced this issue Sep 9, 2020
@Kingwl @amcasey
@typescript-bot @wyze @cherryblossom000 @a-tarasyuk @egamma @andrewbranch
Add see tag support (#39760)
ee5f51b 
* Add see tag parser

* add baseline

* fix symbol resolve

* add more case

* fix unittests

* improve tests and parser

* accept baseline

* Adopt package-lock.json and npm ci

* Add a workflow to update package-lock.json daily

* Git ignore package-lock.json and forcibly update in workflow

* Update bot email address

* Delete extra npm update

* Update package-lock.json

* Add compactDisplay and signDisplay to NumberFormatOptions (#40039)

* Fix typo in (Readonly)Set.keys comment (fixes #40164) (#40176)

* fix(26325): use a unique name for reserved words in 'constructor like' function name (#39684)

* fix(25770): add diagnostic message for the possible mapped type used as an index (#39973)

* fix(31046): add new diagnostic message for incompatible constructor signature (#40073)

* Update package-lock.json

* Update package-lock.json

* Add rename support

* Accpet baseline

* wip

* fix anders

* Revert "fix anders"

This reverts commit b3178d4.

* Fix call hierarchy item serialization and server tests (#40348)

* Avoid error

* accept baseline

* Add more tests

* Add signature name resolve

Co-authored-by: Andrew Casey <[email protected]>
Co-authored-by: TypeScript Bot <[email protected]>
Co-authored-by: Neil Kistner <[email protected]>
Co-authored-by: cherryblossom000 <[email protected]>
Co-authored-by: Alexander T <[email protected]>
Co-authored-by: Erich Gamma <[email protected]>
Co-authored-by: Andrew Branch <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Domain: lib.d.ts The issue relates to the different libraries shipped with TypeScript Good First Issue Well scoped, documented and has the green light Help Wanted You can do this
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix typo in (Readonly)Set.keys comment (fixes #40164)
2 participants
@DanielRosenwasser @cherryblossom000