[CodeStyle][Typos][D-[6-10]] Fix typo("datas","deocder","dafault","decribe","decribes") #7612
Conversation
|
感谢你贡献飞桨文档，文档预览构建中，Docs-New 跑完后即可预览，预览链接：http://preview-pr-7612.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html |
There was a problem hiding this comment.
Pull Request Overview
This PR fixes spelling errors across documentation and code files, and updates the typos configuration file to enable spell checking for these corrections. The changes correct typos like "dafault" to "default", "deocder" to "decoder", "decribe/decribes" to "describe/describes".
Key Changes
- Corrected spelling errors in documentation files (memory_en.rst, error_message_writing_specification_cn.md, tensor.md)
- Fixed variable naming typo in transformer notebook (deocder_emb → decoder_emb)
- Removed typo exceptions from _typos.toml to enable proper spell checking
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/practices/nlp/transformer_in_English-to-Spanish.ipynb | Fixed typo in variable name "deocder_emb" to "decoder_emb" and changed execution_count to null |
| docs/guides/flags/memory_en.rst | Corrected spelling of "dafault" to "default" in two locations |
| docs/dev_guides/style_guide_and_references/error_message_writing_specification_cn.md | Fixed spelling of "dafault_data_type" to "default_data_type" |
| docs/design/concepts/tensor.md | Corrected "decribe" to "describe" and "decribes" to "describes" |
| _typos.toml | Removed incorrect word exceptions (dafault, datas, decribe, decribes, deocder) from the allow list |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
_typos.toml
Outdated
| # Skip `datas ` check in these files | ||
| "docs/practices/time_series/autoencoder.ipynb", | ||
| "docs/practices/nlp/transformer_in_English-to-Spanish.ipynb", | ||
| "docs/guides/06_distributed_training/data_parallel/amp_cn.rst", | ||
| "docs/practices/nlp/addition_rnn.ipynb", | ||
| "docs/practices/cv/pointnet.ipynb" |
There was a problem hiding this comment.
The comment '# Skip datas check in these files' is misleading since this PR removes the 'datas' exception from the allow list. These files are now excluded to preserve the intentional use of 'datas' in those specific files. Consider updating the comment to clarify that these files intentionally use 'datas' and should be excluded from spell checking.
|
可以把 datas 放在 PaddlePaddle specific words 下面吧，就不用忽略文件了 |
已经完成datas加入，包括之前的文件跳过的删除。对于ipynb的json格式的错误修改已经修正。 |
3 participants
PR Category
User Experience
Description
Fix:
修复如下 typo 问题：
"datas",
"deocder",
"dafault",
"decribe",
"decribes"
其中datas全部被设置成为变量名，如果改为data会和代码其他部分出现严重冲突，变量含义混淆等问题，如果修改成其他单词如aBunchOfData 我认为可能没有datas更好，虽然不符合单词逻辑但是确实可读性更强。已经将涉及出问题的文件跳过。
对于deocder也被设为变量名，但是修改后结果可能更好，已经完成修改。
Related links
[CodeStyle][Typos] ✏️ Typos 工具引入 #7543