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.

Sign up for GitHub

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

Jump to bottom

[CodeStyle][Typos][O-W] ✏️ Typos 工具引入计划 #69442

Open
MrXnneHang opened this issue Nov 17, 2024 · 1 comment
Open

[CodeStyle][Typos][O-W] ✏️ Typos 工具引入计划 #69442

MrXnneHang opened this issue Nov 17, 2024 · 1 comment
Assignees
@luotao1 @SigureMo @MrXnneHang
Labels
status/new-issue 新建 type/feature-request 新需求申请

Comments

@MrXnneHang
Copy link
Contributor

MrXnneHang commented Nov 17, 2024 •
edited by SigureMo
Loading

提交PR前先看下PR模板，碰到问题时先看是否有相似问题，优先在这里提问。

PR模板以它为主。

任务背景

这里是姊妹篇。Part1 参见A-N ✏️ Typo 引入计划

此次任务为 ✏️ Typo 清理计划 的后续。

自引入 Typos ，之后我们的 commit 都会伴随对拼写的自动检查。但是，同时也发现先前所遗留的大量拼写问题，为了防止阻塞日常开发，它们目前被记录在_typo.toml中作为定制词库，我们会在本 Issue 中逐步对遗留的拼写问题进行修复。

实施步骤

安装 typos

1.通过 pre-commit 安装：

我们的 pre-commit 中已经配置好了 typos ,你可以直接使用 pre-commit。

pip install pre-commit
pre-commit clean
pre-commit install
pre-commit run typos --all-file # 使用 typos hook 检查所有文件

2.通过 pip 安装:

pip install typos
typos --format brief --exclude build # 检查除了Build文件夹下的所有文件，日志级别brief
typos --format long --exclude build # 日志级别Long

Note

文件是否修改需要同学先自己判断，如果不是很清楚。可以在 Issue 中提问。

  • 原则 1:涉及 API 的改动，不应该修改。
  • 原则 2:不要修改专有名词的缩写，如果发现，请考虑添加到_typo.toml的特殊单词列表中。

问题复现

假设你领取的任务是修改recieve。

打开_typo.toml,注释掉(recieve = 'recieve'行)，然后运行上面的 typos 检查。它会报告所有错误拼写出现的地方。

lastest = 'lastest'
# recieves = 'recieves'
cann = 'cann'
(test) xnne@xnne-PC:~/code/Paddle-Local$ typos --format long --exclude build
error: `recieves` should be `receives`
  --> ./paddle/common/flags_native.cc:371:7
    |
371 |  * It recieves a list of flags name, and will find the corresponding environment
    |       ^^^^^^^^
    |
error: `recieves` should be `receives`
  --> ./paddle/common/flags.h:113:7
    |
113 |  * It recieves commandline arguments passed in argc and argv from main function,
    |       ^^^^^^^^
    |

问题修复

考虑是否修改拼写:

Note

  • 原则 1:涉及 API 的改动，不应该修改。
  • 原则 2:不要修改专有名词的缩写，如果发现，请考虑添加到_typo.toml的特殊单词列表中。

任务列表

O-List
任务 ID 正确拼写 错误拼写(出现次数) 是否需要修正 认领人 PR
🔵O-1 occurred occured(3)、Ocurred(6)
🔵O-2 occurs occures(1)
🔵O-3 of,for,do,go,to Fo(1)、fo(16)
🔵O-4 offsets,offers offets(1)
🔵O-5 offsetted offseted(8)
🔵O-6 old OLT(4)
✅O-7 only olny(1) ✅@guixxiic #69756
🔵O-8 on pn(9)
🔵O-9 operands Operants(141)、operants(481)
🔵O-10 operations oeprations(3)
🔵O-11 operation Opeartion(2)、operaion(4)
🔵O-12 opportunity oppotunity(1)
🔵O-13 optimized optimzed(2)
🔵O-14 optimize optmize(1)
🔵O-15 option optin(3)、Optin(16)
🔵O-16 order oreder(1)、rder(2)
🔵O-17 original orginal(4)、orignal(8)
🔵O-18 ounces,once,ones onces(1)
🔵O-19 outer outter(13)
🔵O-20 output,outputs outpus(8)
✅O-21 outputting outputing(2) ✅@guixxiic #69756
🔵O-22 output outout(2)、ouput(24)、ouptut(26)、outpout(27)、Ouput(33)
✅O-23 outside ouside(1) ✅@guixxiic #69756
🔵O-24 overridden overriden(3)
🔵O-25 override Overide(1)、overide(2)
🔵O-26 overrode,overridden overrided(1)

P-List
任务 ID 正确拼写 错误拼写(出现次数) 是否需要修正 认领人 PR
🔵P-1 package pacakage(12)、Packge(15)
🔵P-2 pad,padded padd(2)
🔵P-3 paid payed(1)
🔵P-4 parallel parellel(1)
🔵P-5 param,pram,parma parm(10)、Parm(13)、PARM(20)
🔵P-6 parameters Paramters(3)、paramters(6)
🔵P-7 parameter paremeter(1)、parmeter(3)、paramter(20)、Paramater(24)、paramete(26)
🔵P-8 parent parrent(1)
🔵P-9 parietal,partial parital(2)
🔵P-10 partial Partitial(1)、partitial(5)
🔵P-11 partition,portion partion(10)
🔵P-12 partition patition(20)
🔵P-13 pass Passs(1)、passs(2)
🔵P-14 paths pathes(1)
🔵P-15 pattern,patent Patten(4)、patten(14)
🔵P-16 patterns,patents pattens(1)
🔵P-17 percent,prescient precent(1)
🔵P-18 performance performace(1)
🔵P-19 performed perfomed(1)
🔵P-20 perform perfome(1)
🔵P-21 persistable presistable(14)
🔵P-22 physical pyhsical(1)
🔵P-23 pipeline pipline(7)
🔵P-24 place,palace palce(6)
🔵P-25 placement Placment(1)
🔵P-26 please,place pleace(2)
🔵P-27 pointer Poniter(8)
🔵P-28 popped,pooped poped(4)
🔵P-29 position,positron positon(1)
🔵P-30 position POSTION(6)
🔵P-31 positive postive(5)
🔵P-32 possible possiable(1)
🔵P-33 potentially potentialy(2)
🔵P-34 preceding precending(1)
🔵P-35 preparation Prepration(1)
🔵P-36 prepare Prepar(1)
🔵P-37 preprocessor preprocesser(10)
🔵P-38 priorities priorites(1)
🔵P-39 probabilistic probabalistic(4)
🔵P-40 processor processer(10)
🔵P-41 process proccess(3)
🔵P-42 produced producted(6)
🔵P-43 program progam(2)
🔵P-44 progress progrss(1)
🔵P-45 propagated propogated(1)
🔵P-46 propagation Propogation(6)
🔵P-47 protocol protocal(1)、PROTOCAL(3)
🔵P-48 python pthon(12)、pyrhon(13)

Q-List
任务 ID 正确拼写 错误拼写(出现次数) 是否需要修正 认领人 PR
🔵Q-1 quick qucik(1)
🔵Q-2 quit quitted(1)

R-List
任务 ID 正确拼写 错误拼写(出现次数) 是否需要修正 认领人 PR
🔵R-1 ran,run,ruined runned(1)
🔵R-2 read,readd,readded readed(1)
🔵R-3 received recived(8)、recevied(9)、recieved(33)、reveived(37)
🔵R-4 receives recieves(2)
🔵R-5 receive recive(1)
🔵R-6 receiving receving(1)
🔵R-7 recommend recommand(1)
🔵R-8 recompile,recomply recomplie(3)
🔵R-9 recorded recored(2)
🔵R-10 recursive,reclusive Recusive(3)、recusive(4)
🔵R-11 recursively Recursivly(1)、recursivly(6)
🔵R-12 redundant reduntant(2)
🔵R-13 referred Refered(9)、refered(54)
🔵R-14 registered registed(56)
🔵R-15 register REGIST(3)、Regiter(4)、Regist(20)、Registe(32)、regist(38)、registe(40)
🔵R-16 related releated(1)
🔵R-17 release realease(2)、relase(3)
🔵R-18 remove reomve(1)
🔵R-19 reorder Reoder(4)
🔵R-20 repeatedly repeatly(3)
🔵R-21 repeat repeate(3)
🔵R-22 replace repalce(2)
🔵R-23 representing,representation represention(11)
🔵R-24 required requied(1)、Reqiured(4)、Requred(5)
🔵R-25 requirements requirments(1)
🔵R-26 resetting Reseting(1)
🔵R-27 reset reseted(3)
🔵R-28 resource resouce(1)
🔵R-29 restore retore(3)
🔵R-30 rewritten rewriten(1)
🔵R-31 rewrote,rewritten rewrited(4)
🔵R-32 running,ruining runing(16)、Runing(20)

S-List
任务 ID 正确拼写 错误拼写(出现次数) 是否需要修正 认领人 PR
🔵S-1 same SMAE(24)
🔵S-2 satisfies satifies(1)
🔵S-3 scalar sclar(1)
🔵S-4 scale sacle(6)
🔵S-5 scheduler sheduler(1)、schduler(2)
🔵S-6 schedule scheule(1)、shedule(5)
🔵S-7 search serach(10)
🔵S-8 second seconde(1)
🔵S-9 selected Seleceted(1)
🔵S-10 sense,since sence(1)
🔵S-11 separately seperately(1)
🔵S-12 separate sepearate(2)、seperate(4)
🔵S-13 separating seperating(1)
🔵S-14 separator seperator(1)
🔵S-15 sequence sequnce(51)、seqence(59)、sequnece(62)、sequece(63)
🔵S-16 sequential sequentail(1)
🔵S-17 serialize serailize(3)
🔵S-18 setting settting(3)
🔵S-19 set setted(16)、ser(38)
🔵S-20 she seh(1)、SEH(3)
🔵S-21 should shoud(2)、shoule(34)
🔵S-22 signal,single Singal(1)
🔵S-23 similar simular(1)、Similiar(2)
🔵S-24 simple,smile,simile Simle(2)
🔵S-25 single,signal signle(1)
🔵S-26 skipped,skyped Skiped(5)、skiped(8)
🔵S-27 small,smell smll(9)
🔵S-28 small samll(1)
🔵S-29 some somme(1)
🔵S-30 spatial Patial(22)、patial(23)
🔵S-31 specified specificed(1)
🔵S-32 split,splits,splice splite(6)
🔵S-33 splitter spliter(2)
🔵S-34 splitting Spliting(1)、spliting(9)
🔵S-35 split Splited(18)、splitted(164)、splited(399)
🔵S-36 square sqaure(2)
🔵S-37 squeeze,sequence sequeze(1)
🔵S-38 startup starup(2)
🔵S-39 statement statment(2)
🔵S-40 statically staticly(1)、staticaly(4)
🔵S-41 statuses,state,static Stati(1)
🔵S-42 stopped stoped(25)、STOPED(43)、Stoped(45)
🔵S-43 storage storeage(4)
🔵S-44 storing,sorting sotring(1)
🔵S-45 strategy stragety(3)
🔵S-46 stream strem(1)
🔵S-47 structured structed(2)
🔵S-48 structure sturcture(1)
🔵S-49 substituted subsituted(1)
🔵S-50 substitute substitue(1)、substitude(2)、Substitude(12)、subsitute(14)、Subsitute(15)
🔵S-51 subtract substract(4)、Substract(5)
🔵S-52 succeeded,success,successful successed(5)
🔵S-53 successfully sucessfully(1)
🔵S-54 success Succeess(1)
🔵S-55 sugar Suger(1)
🔵S-56 supported supportted(7)
🔵S-57 support suppport(1)、supoort(2)、Supprot(3)、suport(4)
🔵S-58 switch SWTICH(2)、Swith(3)
🔵S-59 system sysyem(2)

T-List
任务 ID 正确拼写 错误拼写(出现次数) 是否需要修正 认领人 PR
🔵T-1 target Taget(6)、targt(10)
🔵T-2 template templat(2)
🔵T-3 temporarily Temperarily(1)、temporaily(2)、temporily(3)
🔵T-4 temporary,temporarily,temporally temporaly(1)
🔵T-5 temporary Temperary(1)
🔵T-6 tensor tenosr(12)
🔵T-7 term,item,intern iterm(2)
🔵T-8 terminate termiante(1)
🔵T-9 thanks Thansk(1)
🔵T-10 the,this ths(5)、thi(26)
🔵T-11 theoretical Theoritical(8)
🔵T-12 there,their,the,other ther(5)
🔵T-13 the thr(147)、tne(196)、thge(197)、Teh(198)
🔵T-14 those thouse(4)
🔵T-15 threads thrads(1)、theads(11)
🔵T-16 three,there,their,the thre(5)
🔵T-17 threshold THREAHOLD(2)
🔵T-18 throw THORW(1)
🔵T-19 timeout timout(1)、tiemout(5)
🔵T-20 todo TDOD(1)、TOOD(3)、tood(7)
🔵T-21 together toghether(7)
🔵T-22 to Rto(2)
🔵T-23 training trainning(3)、Traning(5)
🔵T-24 transfer,transformed,transformer,transform transforme(1)
🔵T-25 transferred transfered(17)
🔵T-26 transferring transfering(4)
🔵T-27 transfers tranfers(1)
🔵T-28 transfer tranfer(1)、Tranfer(2)
🔵T-29 transform transfrom(3)、tranform(5)
🔵T-30 transpose Tranpose(7)、tranpose(14)
🔵T-31 trigger tigger(1)
🔵T-32 trimmed trimed(33)
🔵T-33 trivial trival(2)
🔵T-34 true,try Trye(2)
🔵T-35 trying,string,ring tring(6)、Tring(7)
🔵T-36 tuning,running tunning(1)
🔵T-37 tuple TYPLE(3)
🔵T-38 turn trun(1)
🔵T-39 type tpye(1)、tyep(4)

U-List
任务 ID 正确拼写 错误拼写(出现次数) 是否需要修正 认领人 PR
🔵U-1 unchangeable unchangable(3)
🔵U-2 undefined Undefind(2)
🔵U-3 under,unset,unsure,user unser(1)
🔵U-4 unexpected UNEXPECT(2)
🔵U-5 uniform Unifrom(1)
🔵U-6 uninitialized uninitialzed(1)
🔵U-7 unique uniqe(2)、Uniqe(3)、unqiue(4)
🔵U-8 unknown unkonwn(3)、unkown(5)、Unkown(12)
🔵U-9 unsupported UNSUPPORT(11)、unsupport(78)、upsupported(81)、Unsupport(146)
🔵U-10 unzipped unziped(5)
🔵U-11 updated udpated(1)
🔵U-12 upgrade upgarde(1)
🔵U-13 upstream uptream(1)
🔵U-14 use,yes ues(3)
🔵U-15 used,unused,unset unsed(5)
🔵U-16 used uesd(3)
🔵U-17 useful usefull(12)
🔵U-18 useless usless(1)

V-List
任务 ID 正确拼写 错误拼写(出现次数) 是否需要修正 认领人 PR
🔵V-1 vacuum vaccum(5)
🔵V-2 valid,value valud(3)
🔵V-3 validate validat(11)
🔵V-4 valid VAILD(2)
🔵V-5 values,talus,value valus(1)
🔵V-6 values,value valuse(4)
🔵V-7 variable Varible(2)、varaible(3)
🔵V-8 vector vecotr(14)
🔵V-9 version vesion(2)、verson(3)
🔵V-10 vertical Vetical(7)
🔵V-11 vulnerability vunerability(1)

W-List
任务 ID 正确拼写 错误拼写(出现次数) 是否需要修正 认领人 PR
🔵W-1 warn varn(7)
🔵W-2 warped,wrapped warpped(3)
🔵W-3 warper,wrapper warpper(33)、Warpper(36)
🔵W-4 was vas(2)
🔵W-5 weather,whether wether(5)、wheather(6)、Wether(12)
🔵W-6 weights wieghts(1)
🔵W-7 weird werid(2)
🔵W-8 when,we whe(1)
🔵W-9 whether whther(1)、Wheter(2)
🔵W-10 while,will whill(1)
🔵W-11 whose whos(2)
🔵W-12 will,well wil(1)
🔵W-13 will wiil(2)、wll(4)
🔵W-14 with wih(1)、Wih(2)、witk(3)
🔵W-15 work,worked,works worke(2)
🔵W-16 workaround workround(1)
🔵W-17 workspace worksapce(2)
🔵W-18 work wrk(1)
🔵W-19 wrapped wrappered(3)
🔵W-20 wrapper wraper(4)
🔵W-21 wrapping,warping wraping(5)
🔵W-22 writer,written Writter(3)
🔵W-23 wrote,written,write,writer writed(7)

任务认领方式

⭐️ 提交 PR 模版 ⭐️：

  • // ------- PR 标题 --------
[CodeStyle][Typos][A-1] Fix typo(`recieves`)

或者多个任务：

[CodeStyle][Typos][A-1,A-2,A-3] Fix typo(`recieves`...)
[CodeStyle][Typos][A-[1-3]] Fix typo(`recieves`...)

Note

川大同学请注意在任务标题中添加 [SCU]，如：

[CodeStyle][Typos][SCU][A-1] Fix typo(`recieves`...)
[CodeStyle][Typos][SCU][A-1,A-2,A-3] Fix typo(`recieves`...)

⭐️ 认领方式 ⭐️：
请大家以 comment 的形式认领任务，如：

【报名】：A-1、A-3、A-[48-52]

Warning

单个 PR 提交禁止修改超过 10 个文件, 否则会被 reviewer close。
如果单个单词超过 10 个文件的除外。

提交 PR 模版 
<!-- TemplateReference: https://github.com/PaddlePaddle/Paddle/wiki/PULL-REQUEST-TEMPLATE--REFERENCE -->
<!-- Demo: https://github.com/PaddlePaddle/Paddle/pull/24810 -->

### PR Category

<!-- One of [ User Experience | Execute Infrastructure | Operator Mechanism | CINN | Custom Device | Performance Optimization | Distributed Strategy | Parameter Server | Communication Library | Auto Parallel | Inference | Environment Adaptation ] -->

User Experience

### PR Types

<!-- One of [ New features | Bug fixes | Improvements | Performance | BC Breaking | Deprecations | Docs | Devs | Not User Facing | Security | Deprecations | Others ] -->

Devs

### Description

<!-- Describe what you’ve done -->

修复如 typo 问题：

- recieves
- ...

未修复:
- ...

可以的话应该跟随未修复单词提供以下内容，未修复单词所在的行数，以及尽量的，简短的理由:
- recieves
- https://github.com/PFCCLab/dochooks/blob/main/.pre-commit-hooks.yaml#L12 
- 涉及API改动


### Related links

- #本 issue 的序号

@MrXnneHang

状态介绍：
✅：已经完全迁移，所有单测都 OK！
🙋: 报名
🟢：审核完毕待合入，合入之后完成！
🔵：可认领！
🟡：当前阶段不需要人力继续跟进，下阶段推进
🚧：迁移中，单测还没有过，还没有审核完。

大致正常流程为:
🔵 -> 🙋 -> 🚧 -> 🟢 -> ✅

异常流程为:
🔵 -> 🙋 -> 🚧 -> 🟡

📊 任务数量 🔵 可认领 🚧 迁移中 🟢 待合入 ✅ 完成 🟡 下阶段推进 🏁 完成率
258 255 0 0 3 0 1.2%

排名不分先后 @guixxiic(3)
@SigureMo SigureMo assigned luotao1, SigureMo and MrXnneHang and unassigned pkuzyc Nov 17, 2024
@SigureMo SigureMo changed the title [CodeStyle][Typos][O-W] ✏️ Typo 引入计划 [CodeStyle][Typos][O-W] ✏️ Typos 工具引入计划 Nov 17, 2024
@luotao1 luotao1 moved this to In Progress in Call for Contributions Nov 18, 2024
This was referenced Nov 18, 2024
Open
Open
@MrXnneHang MrXnneHang mentioned this issue Nov 18, 2024
Open
@guixxiic
Copy link
Contributor

【报名】：o-7、o-21、o-23

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@luotao1 luotao1

@SigureMo SigureMo

@MrXnneHang MrXnneHang

Labels
status/new-issue 新建 type/feature-request 新需求申请
Projects
Call for Contributions
Status: In Progress
Milestone
No milestone
Development

No branches or pull requests
5 participants
@luotao1 @pkuzyc @SigureMo @MrXnneHang @guixxiic