改了个element-plus文档的错误

557 阅读1分钟

干了啥

改了个 tree 组件 setCheckedKeys 方法的描述

这个文档错误比较老🤔最开始就是错的(看记录是一直都没有修复过的)!

截屏2023-05-13 下午8.09.34.png

现在 element-ui 的文档依然是错误的!我只提交了 element-plus 的 pr,element-ui 就等待有缘人了。

怎么发现的

某天打开文档进行 cv 的时候发现有点不对然后打开了 element-ui 的文档进行验证。

element-plus 文档

截屏2023-05-13 下午8.32.37.png

element-ui 文档

截屏2023-05-13 下午8.33.30.png

可以看出来描述是不一致的

然后选择语言为英语发现描述是一样的是返回节点而不是设置节点所以大概率是文档错了🤔

element-plus 文档

截屏2023-05-13 下午8.37.25.png

element-ui 文档

截屏2023-05-13 下午8.36.55.png

如何改

element-ui、element-plus 文档的国际化是通过 Crowdin 一个在线项目翻译协作平台来实现的, 文档也有说明

现在Crowdin平台的翻译是正确的(可以看到是两天前刚改的)发版后错误应该就会更正。

截屏2023-05-13 下午8.24.07.png

所以应该去改仓库中的英文文档

修改 element-plus 文档

这个对于对开源仓库提交过 pr 的人不算太难,记得先去看对应仓库的贡献文档如 element-plus 的猛击查看

文档 md 文件在 docs/en-US/component

截屏2023-05-13 下午8.44.34.png

找到 tree.md 文件改一下 setCheckedKeys 方法的描述然后提交 pr 等待审核

截屏2023-05-13 下午8.55.32.png

结果如何

ps: 大家不要学我这个 pr 的描述不规范🤪

截屏2023-05-13 下午8.57.24.png

总结

修改了一个 element-plus 文档的错误,水了篇文章😌。