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

docs: add api docs for SettingTopEntry and SettingField models #1804

Merged
merged 1 commit into from
Mar 28, 2023

Conversation

liujuping
Copy link
Collaborator

No description provided.

@liujuping liujuping requested a review from JackLian as a code owner March 28, 2023 08:55
@github-actions
Copy link

ChatGPT Code Review:

CodeReview

根据 diff 文件,这次变更主要是新增了三个文件:node.mdsetting-field.mdsetting-top-entry.md 以及对应的文档内容,主要是介绍设置器相关的模型 SettingTopEntrySettingField,并给出了这些模型的属性和方法的详细说明。

代码看起来没有问题,看起来只是添加了一些注释和方法解释,没有对原有的代码结构造成影响。

修改建议

根据 diff 文件和新增的文档内容,部分方法中方法名和参数名的描述存在歧义,可以考虑对这些方法名和参数名进行解释说明,更能体现其功能。

例如:

  • SettingField.getMockOrValue(),该方法中的 mockvalue 参数名直接使用了术语,对于初次使用者来说可能不太明确,可以在注释中给出具体解释。
  • SettingTopEntry.get(),该方法中的 propName 参数需要更清晰地表达其作用。

合适的 commit message

docs: add api docs for SettingTopEntry and SettingField models
添加了 SettingTopEntrySettingField 模型的 API 文档

@liujuping liujuping changed the title docs: add setting-field and setting-prop-entry api docs docs: add api docs for SettingTopEntry and SettingField models Mar 28, 2023
@JackLian JackLian merged commit 505a640 into develop Mar 28, 2023
@JackLian JackLian deleted the docs/setting-field branch March 28, 2023 09:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants