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(config): add demo for config.getPreference api #1908

Merged
merged 1 commit into from
Apr 19, 2023

Conversation

liujuping
Copy link
Collaborator

No description provided.

@github-actions
Copy link

ChatGPT Code Review:

CodeReview:

  1. getPreference 函数的文档中,返回值的类型应该是 IPublicModelPreference,而不是 IConfigPreference

  2. 在示例代码中,使用了 import 关键字导入了 config 对象,但该示例代码中并没有使用 config 对象,建议删除这个无用的导入语句。

  3. 对于 config.getPreference().set 方法的第三个参数 'skeleton',建议添加必要的注释或文档。

  4. 在事件文档中,没有解释 onceGot 事件的行为和用途,建议添加必要的文档和注释。

修改建议:

  1. getPreference 函数文档中的返回值类型改为 IPublicModelPreference

  2. 删除示例代码中无用的 import {config} 语句。

  3. config.getPreference().set 方法的第三个参数 'skeleton' 添加必要的注释或文档。

  4. 在事件文档中添加必要的文档和注释,解释 onceGot 事件的行为和用途。

Commit Message:

docs(config): add demo and fix typos in config API document

@JackLian JackLian merged commit 82cdafe into develop Apr 19, 2023
1 check passed
@JackLian JackLian deleted the docs/config-getPreference-demo branch April 19, 2023 06:36
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.

None yet

2 participants