luckyframework/avram

Add inline documentation

开放

#35 创建于 2017年12月4日

 (0 条评论) (0 个反应) (0 位负责人)Crystal (67 个派生)auto 404
good first issue

仓库指标

星标
 (180 个星标)
PR 合并指标
 (PR 指标待抓取)

描述

Inline documentation was purposely left off when things were changing, but now the API is starting to stabilize. Adding documentation to the public facing methods would be fantastic.

If you'd like to help, here is how Crystal docs work: https://crystal-lang.org/docs/conventions/documenting_code.html

Feel free to make small PRs so it's easy to review and merge them in :D

Thanks so much for the help!

贡献者指南