Add Version Numbers to Library Interfaces
Les mainteneurs répondent en général sous 4 jours
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Accessibilité débutants
- 25/100
- Type d'issue
- Fonctionnalité
- Clarté
- À clarifier
- Activité
- À l'abandon
- Stack technique
- javascript
- Domaine
- documentation
Piste de recherche
Aucun fichier, test ou point d’entrée de la documentation n’est identifié dans l’issue. Commencez par examiner la structure de testing-library-docs et la documentation de son interface, puis déterminez comment représenter les métadonnées de version et les variantes historiques de l’API ; le travail est considéré comme terminé lorsqu’une approche définie et maintenable est documentée et appliquée de manière cohérente.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
Is your feature request related to a problem? Please describe.
I would love to be able to look at each documented interface of a library and learn which version of the library first supported it. The testing library libraries evolve very quickly, and I'd love to learn just by looking at the documentation which version of the library first supported the interface.
As an example, the screen interface shipped at the very end of 2019. I'd like to see what version of the given library supports that API. So if I am using @testing-library/[email protected] I'd want to know if I have access to that feature or not.
Describe the solution you'd like
I'd like to see just a simple mention of what version the feature was first introduced, or alternatively a range of versions the feature supported (perhaps the API mutated between major versions, and you'd like to document the 9.0 - 11.0 behavior, but 12.0 would be different).
Describe alternatives you've considered
As I mentioned above, I see a couple ways this could be implemented. The shorter, simpler, solution would probably be to just list the version it was introduced in. An alternative would be to list the documentation for each permutation an interface undertook, for instance if a method added an argument to its parameters, then both permutations could be listed, perhaps with the deprecated API docs collapsed by default.
There's probably endless room for creativity with this.
Additional context
Thanks for considering it? :)
- Langage dominant
- JavaScript
- Étoiles
- 479
- Forks
- 737
- Merge moyen
- 5 j 1 h
- PR mergées (30 j)
- 2
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Aucun modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de testing-library/testing-library-docs
-
Broken Chrome Extension Link in Queries DocsPeut-être pris @rajanpanth l’a pris il y a 76 jours. Ouverte
Difficulté 1/5 Moins d'une heure Accessibilité débutants 72/100
testing-library/testing-library-docs#1499 ·
Les mainteneurs répondent en général sous 4 jours
-
Difficulté 4/5 3-5 jours Accessibilité débutants 48/100
testing-library/testing-library-docs#1528 ·
Les mainteneurs répondent en général sous 4 jours
-
Framework wrappers and DOM testing libraryPeut-être pris @jacklaurencegaray l’a pris il y a 438 jours. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 38/100
testing-library/testing-library-docs#1493 · 3 commentaires ·
Les mainteneurs répondent en général sous 4 jours
-
Difficulté 2/5 1-3 heures Accessibilité débutants 55/100
testing-library/testing-library-docs#1486 · 1 réaction ·
Les mainteneurs répondent en général sous 4 jours
-
Difficulté 2/5 1-3 heures Accessibilité débutants 48/100
testing-library/testing-library-docs#1485 · 1 commentaire ·
Les mainteneurs répondent en général sous 4 jours
Toutes les issues de testing-library/testing-library-docs
Issues similaires
-
Difficulté 2/5 1-3 heures Accessibilité débutants 85/100
pigeon189/zcode-fox-widget#17 · 1 commentaire ·
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 88/100
Les mainteneurs répondent en général sous 1 jour
-
Let TypeScript accept an initial object in ReactiveDictPeut-être pris @yograj-vijay-yadav l’a pris aujourd’hui. Ouvertebug good first issue help wanted workshop
Difficulté 2/5 1-3 heures Accessibilité débutants 92/100
meteor/meteor#14919 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
akitaonrails/FrankMD#268 ·
Les mainteneurs répondent en général sous 1 jour
-
good first issue
Difficulté 2/5 1-3 heures Accessibilité débutants 88/100
Les mainteneurs répondent en général sous 1 jour