Add Version Numbers to Library Interfaces
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 25/100
- Issue 类型
- 功能
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
- 技术栈
- javascript
调研方向
Issue 中未确定任何文件、测试或文档入口。首先检查 testing-library-docs 的结构及其接口文档，然后确定应如何表示版本元数据和历史 API 变体；当一个明确且可维护的方法已被记录并一致地应用时，即视为完成。
由索引模型根据 Issue 内容生成。
描述
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? :)
- 主要语言
- JavaScript
- 星标
- 479
- 派生
- 738
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
testing-library/testing-library-docs 的其他 Issue
-
Vue - FAQ about Vue Router is outdated可能已有人在做 @SatvikMishra08 于 9 天前认领。 未关闭
难度 1/5 1 小时以内 新手友好度 88/100
testing-library/testing-library-docs#1570 · 1 条评论 ·
-
Broken Chrome Extension Link in Queries Docs可能已有人在做 @rajanpanth 于 58 天前认领。 未关闭
难度 1/5 1 小时以内 新手友好度 72/100
-
难度 4/5 3-5 天 新手友好度 48/100
-
Framework wrappers and DOM testing library可能已有人在做 @jacklaurencegaray 于 420 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 38/100
testing-library/testing-library-docs#1493 · 3 条评论 ·
-
难度 2/5 1-3 小时 新手友好度 55/100
testing-library/testing-library-docs#1486 · 1 个 reaction ·
查看 testing-library/testing-library-docs 的全部 Issue
相似的 Issue
-
area: docs good first issue
难度 2/5 1-3 小时 新手友好度 64/100
维护者通常 1 天内回复
-
Support
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
openseadragon/openseadragon#2996 ·
维护者通常 3 天内回复
-
难度 2/5 1-3 小时 新手友好度 75/100
jfromaniello/url-join#134 ·
-
难度 2/5 1-3 小时 新手友好度 74/100