Microsoft/TypeScript

Docs of `charCodeAt` and `codePointAt` are flipped

Open

#49.561 geöffnet am 15. Juni 2022

Auf GitHub ansehen
 (8 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (6.726 Forks)batch import
BugDomain: lib.d.tsHelp Wanted

Repository-Metriken

Stars
 (48.455 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 6T 17h) (9 gemergte PRs in 30 T)

Beschreibung

Bug Report

Docs of charCodeAt and codePointAt are flipped. Described in MDN, the codePointAt returns Unicode code point, and charCodeAt returns UTF16 char code, however in JSDoc string of Typescript they are flipped.

How it is

https://github.com/microsoft/TypeScript/blob/89d05f7131b233c4482aaba5c15ad289f26173b4/lib/lib.es2015.core.d.ts#L401-L408

https://github.com/microsoft/TypeScript/blob/89d05f7131b233c4482aaba5c15ad289f26173b4/lib/lib.es5.d.ts#L404-L408

How it should be

The codePointAt() method returns a non-negative integer that is the Unicode code point value at the given position. Note that this function does not give the nth code point in a string, but the code point starting at the specified string index. Docs

The charCodeAt() method returns an integer between 0 and 65535 representing the UTF-16 code unit at the given index. Docs

Contributor Guide

Research-Richtung
Das Problem meldet, dass die JSDoc Beschreibungen für `String.prototype.charCodeAt` und `String.prototype.codePointAt` vertauscht sind. Zur Behebung finden Sie die Datei lib.es5.d.ts (für charCodeAt) und lib.es2015.core.d.ts (für codePointAt) im TypeScript Repository. Tauschen Sie die Beschreibungen aus, sodass `codePointAt` als Rückgabe des Unicode Codepoints und `charCodeAt` als Rückgabe der UTF 16 Codeeinheit beschrieben wird. Folgen Sie der im Issue verlinkten MDN Dokumentation für den korrekten Text.
Tech Stack
typescript
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Keine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
95