希望可以增加对API文档的使用说明
wmui opened this issue · comments
目前API文档对各个方法的使用和介绍比较笼统，只对特别常用的API进行了示例说明，但那些不太常用的API其实也很重要，比如insert方法。
详细的文档，对于那些不太熟悉ORM的用户帮助很大。我是在Egg中使用egg-orm操作数据库，考虑到使用egg的用户部分是偏前端，文档对我们这类的用户帮助很大🙏🏻
很好的建议，可以多列举一些想要进一步了解的 api，我们会去完善
主要是Modules下面的API，基本都一笔带过了。classes下面的api，由于大部分orm提供的都差不多，这点不影响使用。api
的组织和描述，个人觉得可以借鉴vue api官方，很清晰易懂
想起来其实我们有一个 jsdoc 生成的版本 https://leoric.js.org/api/
可读性还不是特别好，会继续完善