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!

貢獻者指南