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

希望可以增加对API文档的使用说明 #394

Open
wmui opened this issue Jun 16, 2023 · 3 comments
Open

希望可以增加对API文档的使用说明 #394

wmui opened this issue Jun 16, 2023 · 3 comments

Comments

@wmui
Copy link

wmui commented Jun 16, 2023

目前API文档对各个方法的使用和介绍比较笼统,只对特别常用的API进行了示例说明,但那些不太常用的API其实也很重要,比如insert方法。

详细的文档,对于那些不太熟悉ORM的用户帮助很大。我是在Egg中使用egg-orm操作数据库,考虑到使用egg的用户部分是偏前端,文档对我们这类的用户帮助很大🙏🏻

@cyjake
Copy link
Owner

cyjake commented Jun 16, 2023

很好的建议,可以多列举一些想要进一步了解的 api,我们会去完善

@wmui
Copy link
Author

wmui commented Jun 16, 2023

主要是Modules下面的API,基本都一笔带过了。classes下面的api,由于大部分orm提供的都差不多,这点不影响使用。api
的组织和描述,个人觉得可以借鉴vue api官方,很清晰易懂

@cyjake
Copy link
Owner

cyjake commented Nov 7, 2023

想起来其实我们有一个 jsdoc 生成的版本 https://leoric.js.org/api/

可读性还不是特别好,会继续完善

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

No branches or pull requests

2 participants