Add Version Numbers to Library Interfaces
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Stack tecnológico
- javascript
- Área
- documentation
Línea de trabajo
En el issue no se identifican archivos, pruebas ni puntos de entrada de la documentación. Primero inspecciona la estructura de testing-library-docs y la documentación de su interfaz; después determina cómo deben representarse los metadatos de versión y las variantes históricas de la API. Se considera terminado cuando se haya documentado y aplicado de forma coherente un enfoque definido y mantenible.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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? :)
- Lenguaje dominante
- JavaScript
- Estrellas
- 479
- Forks
- 738
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de testing-library/testing-library-docs
-
Vue - FAQ about Vue Router is outdatedPosiblemente ocupada @SatvikMishra08 la tomó hace 6 días. Abierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
testing-library/testing-library-docs#1570 · 1 comentario ·
-
Broken Chrome Extension Link in Queries DocsPosiblemente ocupada @rajanpanth la tomó hace 55 días. Abierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 72/100
-
Dificultad 4/5 3-5 días Aptitud para principiantes 48/100
-
Framework wrappers and DOM testing libraryPosiblemente ocupada @jacklaurencegaray la tomó hace 417 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 38/100
testing-library/testing-library-docs#1493 · 3 comentarios ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 55/100
testing-library/testing-library-docs#1486 · 1 reacción ·
Todos los issues de testing-library/testing-library-docs
Issues similares
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
capricorn86/happy-dom#2485 ·
Los mantenedores suelen responder en 2 días
-
area:space-accuracy good first issue track:data
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
Sara-Managed-Projects/space-radar#904 ·
Los mantenedores suelen responder en 1 día