stdlib-js / stdlib-js/stdlib

Linting docstrings bug

Offen
#1,042 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Tools
Vorherrschende Sprache
JavaScript
Sterne
6k
Forks
1.3k
Ø Merge
1 T. 3 Std.
Gemergte PRs (30 T.)
611

Beschreibung

This is a follow up issue from the discussion _Originally posted by @kgryte in https://github.com/stdlib-js/stdlib/pull/1041#discussion_r1244843249_

The CI linter passed even though the returned array in the docstring was `Float64Array`, but the data type of the input array is `generic`.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Start with the discussion referenced in pull request #1041, which describes the linter accepting a docstring return type of Float64Array for a generic input array. Reproduce that case in CI or the linter’s existing checks and determine what validation is missing. Done means the mismatch is detected and covered by an appropriate test.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript
Bereich
tooling
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
30/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.