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.

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

关键词突出显示规则讨论 #11

Open
surechen opened this issue Nov 4, 2021 · 1 comment
Open

关键词突出显示规则讨论 #11

surechen opened this issue Nov 4, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@surechen
Copy link
Contributor

surechen commented Nov 4, 2021

Hi,我注意到一些关键词可能需要突出显示的问题,我想我们需要制定一个标准,方便开发者添加新的规则时判断是否需要加粗或采取其他方法突出显示这些关键词

  1. 对于G规则中的lint描述,目前部分Lint Group字段,如complexity有加粗,如pedantic、correctness等没有加粗提示,level字段没有加粗的提示,我建议我们确定一个标准,比如对于level为deny和warn的加粗,allow不加粗,对于Lint Group字段,都加粗,给用户明显的提示;
lint name Clippy 可检测 Rustc 可检测 Lint Group level
unnecessary_operation yes no complexity warn

2.对于G.VAR.03,有如下描述:

Rust 语言默认支持 Non ASCII 字符作为合法标识符。但是,为了统一团队代码风格,建议使用最常用的 ASCII 字符作为合法标识符。

另外,只有使用英文的命名才能让 命名相关 的 Lint 生效。

其中通过空格强调名词“命名相关“,由于空格并不是特别明显,且目前中文和英文之间也使用空格来区分,我建议对于需要强调的关键名词通过加粗来提示,如下:

另外,只有使用英文的命名才能让**命名相关**的 Lint 生效。
@surechen surechen changed the title 关键字加粗提示 关键字加粗讨论 Nov 4, 2021
@surechen surechen changed the title 关键字加粗讨论 关键词突出显示讨论 Nov 4, 2021
@surechen surechen changed the title 关键词突出显示讨论 关键词突出显示规则讨论 Nov 4, 2021
@ZhangHanDong
Copy link
Contributor

基本认同。我晚点把这个规则加到贡献者指南中。

@ZhangHanDong ZhangHanDong added the documentation Improvements or additions to documentation label Nov 4, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants