downshift-js/downshift

JSDoc comments in typings to enhance usability of props

Open

#1.057 geöffnet am 20. Mai 2020

Auf GitHub ansehen
 (2 Kommentare) (3 Reaktionen) (0 zugewiesene Personen)JavaScript (11.761 Stars) (980 Forks)batch import
chorehelp wanted

Beschreibung

  • downshift version: 5.4.0

Problem description:

Currently, all descriptions of props are found through Github. They are nice and all, but it is a hassle to access the repo every time I need to read further up on the props.

Suggested solution:

Add all descriptions to index.d.ts from the README's in a JSDoc-like format (e.g. typedoc), thus having the descriptions readily available through your IDE/editor of choice

Here is an example of what it may look like in VSCode when a line was added. image

Contributor Guide

Tech Stack
javascripttypescriptreact
Domain
developer experiencedocumentation
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
TypeScriptJSDocFamiliarity with downshift API
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85
Research-Richtung
Open the index.d.ts file in the repository. For each prop defined in the type definitions, locate the corresponding description in the README.md files (e.g., docs/). Then add /** ... */ JSDoc comments above each prop with the description. Ensure the comments are formatted correctly to be picked up by TypeScript and IDEs. There are no blockers or linked PRs.