修改 mdlint 中的非包容性字词
Fuchsia 使用 mdlint
(一种 Markdown linter)对 Fuchsia 源代码树中的文档强制执行特定规则。mdlint
有一个非包容性语言检测器,该检测器使用一个包含非包容性字词及其各自替代词的 JSON 文件。
如需更新、移除或向非包容性语言列表添加内容,请执行以下操作:
更新列表
- 打开
/tools/mdlint/rules/respectful_code_words.json
。
如需添加或修改非包含字词的建议,请附加英文逗号并编写新建议。例如:
"master": "main, primary,new suggestion",
从列表中删除
- 打开
/tools/mdlint/rules/respectful_code_words.json
。
删除包含不包含字词和建议的整行内容。
添加到列表
- 打开
/tools/mdlint/rules/respectful_code_words.json
。
- 根据列表中字词的字母顺序,在字词之间添加一个换行符。
请加上相应字词及其包含性建议。例如:
"non-inclusive word": "first inclusive suggestion, second inclusive suggestion...",
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2024-03-15。
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"没有我需要的信息"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"太复杂/步骤太多"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"内容需要更新"
},{
"type": "thumb-down",
"id": "translationIssue",
"label":"翻译问题"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"示例/代码问题"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"其他"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"易于理解"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"解决了我的问题"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"其他"
}]