Skip to content

[CodeStyle][Typos] ✏️ Typos 工具引入 #7543

New issue
New issue
Open
Open
[CodeStyle][Typos] ✏️ Typos 工具引入#7543
Assignees
luotao1sunzhongkai588ooooo-create
Labels
PFCCPaddle Framework Contributor Club，https://github.com/PaddlePaddle/community/tree/master/pfccgood first issueGood for newcomers
@ooooo-create

Description

@ooooo-create
ooooo-create
opened on Oct 11, 2025

背景 (Background)

为了进一步提升 PaddlePaddle 官方文档的专业性和准确性，我们计划引入自动化拼写检查工具 typos。文档中的拼写错误会影响用户的阅读体验，甚至可能导致对技术细节的误解。引入自动化检查工具可以在代码合并前发现并修复这些问题，是保障文档质量的有效手段。

对齐主仓库实践 (Alignment with Main Repository)

typos 工具已经在 Paddle 主仓库中成功引入并得到了良好实践，有效保障了代码注释和文档字符串的质量。这证明了该工具的价值和可行性。
相关的实践和讨论可以参考下面几个 issue：

在 docs 仓库中引入 typos，是我们将代码质量保障的最佳实践扩展到文档生态、保持项目整体一致性的重要一步。

任务目标 (Task Goals)

引入配置文件：在 docs 仓库根目录添加 typos 的配置文件 (_typos.toml)。需要根据文档的特性和常用术语，定制化词典，避免误报。
集成至 pre-commit 和 CI 中：确保所有新的 Pull Request 在合并前都会经过拼写检查，并且本地 commit 的时候就可发现 typo。
修复存量问题：在引入配置文件时，会给所有认为是 typo 单词都加入定制化词典，我们需要确认是否为 typo，对于 typo 我们需要手动修改它们

任务列表

A-List
任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
🔵A-1 Accuracy, Actuary Accuray
🔵A-2 Advantages Adventages
🔵A-3 Architecture Archetecture
🔵A-4 Asynchronous Asynchoronous
🔵A-5 Attribute Attrbute , Attribtue
🔵A-6 acceptance accpetance
🔵A-7 according accordding
✅A-8 accuracy accracy ✅@ooooo-create #7545
🔵A-9 acoustic accoustic
✅A-10 actual acutal ✅@ooooo-create #7545
✅A-11 approach apporach ✅@ooooo-create #7545
✅A-12 approaches apporaches ✅@ooooo-create #7545
✅A-13 arguments arguements , arguemnts ✅@ooooo-create #7545
✅A-14 assign assgin ✅@ooooo-create #7545
✅A-15 assignment assginment ✅@ooooo-create #7545
✅A-16 auxiliary auxilary ✅@ooooo-create #7545
✅A-17 available avaiable ✅@ooooo-create #7545

B-List
任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
🔵B-1 Boundary Bounary
🔵B-2 basic baisc , basci
🔵B-3 because beacuse
🔵B-4 benchmark bechmark , benckmark
🔵B-5 broadcast boradcast , brodcast

C-List
任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
🔵C-1 Classification Classfication
🔵C-2 Comparison Comparision
🔵C-3 Contracting, Constructing Contructing
🔵C-4 calculate caculate
🔵C-5 chosen choosen
🔵C-6 classification classfication
🔵C-7 classify classfy
🔵C-8 clipping cliping
🔵C-9 columns colunms
🔵C-10 commit commmit
🔵C-11 compile, complice, complied complie
🔵C-12 conditional condtional
🔵C-13 conjunction conjuction
🔵C-14 construct contruct
🔵C-15 constructed contructed
🔵C-16 construction contruction
🔵C-17 containing containg
🔵C-18 contains cantains
🔵C-19 context contxt
🔵C-20 convenience convinience
🔵C-21 conversion convertion
🔵C-22 corresponding correponding , corresonding , correspoinding
🔵C-23 could, should, sold sould
🔵C-24 creates creats
🔵C-25 creation creatation
🔵C-26 cross, course corss

D-List
任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
🔵D-1 DECLARE DELCARE
🔵D-2 Dataset Dateset
🔵D-3 Description Discription
🔵D-4 Direct Driect
🔵D-5 Distributed Distrbuted
🔵D-6 data datas
🔵D-7 decoder deocder
🔵D-8 default dafault
🔵D-9 describe decribe
🔵D-10 describes decribes
🔵D-11 design desgin
🔵D-12 design, designing desigin
🔵D-13 designated desginated
🔵D-14 determined determinated
🔵D-15 difficult diffcult
🔵D-16 dimension dimention
🔵D-17 dimensions dimentions
🔵D-18 directories dirrectories
🔵D-19 discussion disucssion

E-List
任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
🔵E-1 Embedding Embeddding , Embeding
🔵E-2 English Engish
🔵E-3 edge egde
🔵E-4 environment enviornment
🔵E-5 errors erros
🔵E-6 evaluate evalute
🔵E-7 example exmaple
🔵E-8 examples exampels
🔵E-9 exclusive exlusive
🔵E-10 execution, ejection, election, exertion exection
🔵E-11 exists, exist exsits

F-List
任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
🔵F-1 False Fasle
🔵F-2 False, Flake, Flame, Flare, Flash, Flask Flase
🔵F-3 fed feeded
🔵F-4 filter, liter ilter
🔵F-5 filters fliters
🔵F-6 float flaot
🔵F-7 following follwing
🔵F-8 formatted formated
🔵F-9 formatter formater
🔵F-10 forward forword , foward
🔵F-11 function funtion
🔵F-12 functional functinal
🔵F-13 fundamental fundemental

G-List
任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
🔵G-1 Generator, Generated, Generates, Generate Generater
🔵G-2 Global Gloabal
🔵G-3 generally generaly
🔵G-4 global gloabl
🔵G-5 guard gard

H-List
任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
🔵H-1 height, high heigh

I-List
任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
🔵I-1 Improvement Imporvement
🔵I-2 Interface Interfce
🔵I-3 identical indentical
🔵I-4 ignore ingore
🔵I-5 image imge
🔵I-6 implemented implememted
🔵I-7 index indx
🔵I-8 indices indeces , indicies
🔵I-9 inferred infered
🔵I-10 info, inform infor
🔵I-11 initializers intializers
🔵I-12 input intput
🔵I-13 insert instert
🔵I-14 interchangeable interchangable
🔵I-15 interface inferface
🔵I-16 intrinsics instrinsics

K-List
任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
🔵K-1 Kernel Kernal

L-List
任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
🔵L-1 Learning Learing
🔵L-2 label, ladle, labile, able lable
🔵L-3 learn leran
🔵L-4 learning learing
🔵L-5 length legth , lenth
🔵L-6 lengths lengthes
🔵L-7 library libary
🔵L-8 likely likey

M-List
任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
🔵M-1 Mobile Moible
🔵M-2 maintained mantained
🔵M-3 matrix, matrices, metrics matrics
🔵M-4 mechanism mechnism
🔵M-5 memory memeory , memroy
🔵M-6 message messege
🔵M-7 metaphor metaphore
🔵M-8 metrics, matrices metrices
🔵M-9 module mdule
🔵M-10 multiply muliply
🔵M-11 multiplying mulitplying
🔵M-12 mutable mutbale

N-List
任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
🔵N-1 Nirvana Nervana
🔵N-2 Numeric Numberic
🔵N-3 necessary nessesary
🔵N-4 needed neeeded
🔵N-5 numeric numberic

O-List
任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
🔵O-1 Operation Operaton
🔵O-2 Optimizer Optimzier
🔵O-3 Optimizing Optimizaing
🔵O-4 occurrence occurence
🔵O-5 operator opeartor
🔵O-6 operators opeartors
🔵O-7 operators, operates operaters
🔵O-8 optimization optmization
🔵O-9 output outpu
🔵O-10 output, outputs outpus
🔵O-11 overrode, overridden overrided
🔵O-12 overwritten, overwrote overwrited

P-List
任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
🔵P-1 Parallel Prallel
🔵P-2 Parameter Paremeter
🔵P-3 Pipeline Pipline
🔵P-4 Program Porgram
🔵P-5 Propagation Propegation , Propogation
🔵P-6 Protocol Protocal
🔵P-7 Python Pyhton
🔵P-8 parameters parammeters
🔵P-9 place, palace palce
🔵P-10 pointer poniter
🔵P-11 process porcess
🔵P-12 processor processer
🔵P-13 prompt, promote promot
🔵P-14 propagation propegation
🔵P-15 provided provicded

R-List
任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
🔵R-1 REGISTER REGISTE
🔵R-2 Request Reuqest
🔵R-3 Review Reivew
🔵R-4 received recevied
🔵R-5 recommend recomment
🔵R-6 registered, registers registerd
🔵R-7 registering registring
🔵R-8 release relase
🔵R-9 requirements requirments
🔵R-10 result resut
🔵R-11 results resuts
🔵R-12 review reivew

S-List
任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
🔵S-1 Screenshot Creenshot
🔵S-2 Segment Setment
🔵S-3 Similarly Similarily
🔵S-4 Simple, Smile, Simile Simle
🔵S-5 Solver Sovler
🔵S-6 Succeeded, Success, Successful Successed
🔵S-7 sample, same samle
🔵S-8 satisfies satifies
🔵S-9 scale, sale, sable sacle
🔵S-10 scenarios secenarios
🔵S-11 schedule schedual
🔵S-12 semantic sematic
🔵S-13 separated sperated
🔵S-14 separator seperator
🔵S-15 set ser , setted
🔵S-16 should shoule
🔵S-17 similarly similary
🔵S-18 simpler simplier
🔵S-19 size szie
🔵S-20 skipped, skyped skiped
🔵S-21 software softwares
🔵S-22 special specail
🔵S-23 split splited , splitted
🔵S-24 strategy stradegy
🔵S-25 string stirng
🔵S-26 subtract subract
🔵S-27 success sucess
🔵S-28 successor sucessor
🔵S-29 successors sucessors

T-List
任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
🔵T-1 Tensor Tenosr
🔵T-2 The Tthe
🔵T-3 Training Traning
🔵T-4 Transformed Transfomed
🔵T-5 Transformer Tansformer
🔵T-6 True, Pure Ture
🔵T-7 target traget
🔵T-8 temporary tempory
🔵T-9 tensor tenosr
🔵T-10 their thier
🔵T-11 threshold treshold
🔵T-12 train, trial trian
🔵T-13 training traing , trainning , traning
🔵T-14 transferred transfered
🔵T-15 transformed trasformed

U-List
任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
🔵U-1 Usage Useage
🔵U-2 unique unqiue
🔵U-3 unsupported unsupport
🔵U-4 until, utils utill
🔵U-5 update updte

V-List
任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
🔵V-1 Variable Varialble , Varible
🔵V-2 Variant Varient
🔵V-3 variable varibale
🔵V-4 variables varialbes , varibales
🔵V-5 variance varience
🔵V-6 variant varient
🔵V-7 visiting, listing visting

W-List
任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
🔵W-1 Weather, Whether Wether
🔵W-2 warped, wrapped warpped
🔵W-3 weather, whether wether
🔵W-4 with wiht
🔵W-5 working workign
🔵W-6 wrapper wraper
🔵W-7 write wirte
🔵W-8 writer, written writter

任务认领方式

⭐️ 提交 PR 模版 ⭐️：

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

或者多个任务：

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

⭐️ 认领方式 ⭐️：

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

【报名】：A-1、A-3、A-[5-6]
提交 PR 模版 
### PR Category
User Experience

### Description
<!-- Describe what you’ve done -->
修复如下 typo 问题：
- recieves
- ...
未修复: # (单词/所在文件行数)。可以的话，尽量简短说明一下原因。
text:
- xxxx
...

### Related links
- #7543

@ooooo-create

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

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

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

看板信息

任务数量 🔵 可认领 🚧 迁移中 🟢 待合入 ✅ 完成 🟡 下阶段推进 🏁 完成率
242 233 0 0 9 0 3.7%

排名不分先后 @ooooo-create(9)

Metadata

Metadata

Assignees

Labels

PFCCPaddle Framework Contributor Club，https://github.com/PaddlePaddle/community/tree/master/pfccgood first issueGood for newcomers

Type

No type

Projects

Call for Contributions

Status

In Progress

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions