luckyframework/avram

Add inline documentation

オープン

#35 opened on 2017/12/04

 (0 件のコメント) (0 件のリアクション) (0 人の担当者)Crystal (67 件のフォーク)auto 404
good first issue

Repository metrics

Stars
 (180 個のスター)
PR merge metrics
 (PR metrics pending)

説明

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!

コントリビューターガイド