Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Version Numbers to Library Interfaces #484

Open
JimmayVV opened this issue Jun 2, 2020 · 4 comments
Open

Add Version Numbers to Library Interfaces #484

JimmayVV opened this issue Jun 2, 2020 · 4 comments
Labels
enhancement nice to have 😎 Enhancement/cool feature organization 📂 Something needs to be moved

Comments

@JimmayVV
Copy link

JimmayVV commented Jun 2, 2020

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/react@9.3.0 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? :)

@alexkrolick
Copy link
Collaborator

Good idea. The Nodejs docs do that.

@nickserv nickserv mentioned this issue Oct 7, 2020
@nickserv nickserv added nice to have 😎 Enhancement/cool feature organization 📂 Something needs to be moved labels Oct 7, 2020
@elpddev
Copy link

elpddev commented Mar 22, 2023

Came here looking for the v12 docs. Would be much helpful for projects trying to migrate from older versions of react.

@MatanBobi
Copy link
Member

There are some stuff we need to consider here. Since our docs site contains the docs for all of the testing-library organization, packages aren't following the same version number. We need to discuss this one to understand how we can answer this requirement in a way that will be relevant to all packages :)

@alexkrolick
Copy link
Collaborator

As a starting point, adding inline notes to significant features that say something like "added in v9.1.3" would be helpful.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement nice to have 😎 Enhancement/cool feature organization 📂 Something needs to be moved
Projects
None yet
Development

No branches or pull requests

5 participants