跳到内容
新发行

对这个项目有疑问吗?注册一个免费的GitHub帐户以打开一个问题,并联系其维护者和社区。

单击“注册GitHub”,表示您同意我们的服务条款隐私声明。我们偶尔会向您发送与帐户相关的电子邮件。

已经在GitHub上了?登录到您的帐户

修复e2e-test-utils剧作家的jsdoc和类型 #48266人

已合并
将2个提交合并到
2023年2月22日

对话

凯文940726
复制链接
成员

什么?为什么?

该公关有两件事:

  1. 修复中的jsdoce2e-test-utils剧作家从夹具中使用时。现在,当鼠标悬停在方法上时,它正确地显示了jsdoc。
  2. 删除jsdoc类型以支持typescript类型。jsdoc类型从不强制执行,并且可能不同步。如果可能,最好参考TS类型。

怎么用?

发挥想象力@借款jsdoc魔术从纯函数到类字段的jsdoc。由于一些循环依赖性问题,我们还必须手动键入类字段:方法类型名称显示jsdoc。

测试说明

npm运行构建:包

将鼠标悬停在支持的编辑器中的一些util上,然后查看jsdoc。

注意:
您必须调用函数才能显示完整的jsdoc。也就是说,悬停editor.get块不会显示jsdoc,但会悬停在上面编辑器.getBlocks()将显示jsdoc。这可能是一个jsdoc或typescript错误。

屏幕截图或屏幕广播

VSCode中的jsdoc:

形象

@github-操作
复制链接

github-操作 机器人程序 评论2023年2月21日

在3dada1e345e52fcc4c522db1e77935bb8b2f0e6f中检测到片状测试。
一些测试通过,但尝试失败。失败可能与此提交无关,但仍会报告以供查看。请参见文档了解更多信息。

🔍 工作流运行URL:https://github.com/WordPress/gutenberg/actions/runs/4229596957
📝 报告的问题:

复制链接
成员

@马马杜卡 马马杜卡 留下了评论

选择隐藏此评论的原因

将显示原因,以便向其他人描述此评论。了解更多信息.

谢谢您,@凯文940726!

内联提示现在看起来好多了。

CleanShot 2023-02-22,09 35 29

@凯文940726 凯文940726合并提交b80d848号进入之内 大旅行箱 2023年2月22日
@凯文940726 凯文940726删除了 修复/剧作家-utils-jsdoc 分支 2023年2月22日06:02
@github-操作 github-操作 机器人程序将此添加到古腾堡15.3里程碑2023年2月22日
免费注册 在GitHub上加入此对话.已经有帐户了吗?登录以发表评论
标签
[类型]开发人员文档 开发人员文档
项目
还没有
开发

成功合并此请求可能会解决这些问题。

还没有

2名参与者