search

ftnext / PyConTalkSummary

PyConで聞いたトークのサマリーをIssueに蓄積（arXivTimesリスペクト）
0 stars 0 forks source link

[PyCon JP 2019] チームメイトのためにdocstringを書こう #49

Open ftnext opened 1 year ago

ftnext commented 1 year ago

一言でいうと

3連クォートで囲んだ文字列＝docstringはコード内のドキュメント。 オススメは型ヒント + reSTスタイル。 Sphinxを使ってdocstringからドキュメントを自動生成できる

https://nikkie-ftnext.hatenablog.com/entry/sphinx-ext-autodoc-with-sphinx-new-tab-link で言及したのでアーカイブを消化した

発表資料リンク

https://pycon.jp/2019/sessions/?sessionId=224

発表者/所属

ku-muさん

発表日付

2019/09/17

概要

https://scrapbox.io/nikkie-memos/%E3%83%81%E3%83%BC%E3%83%A0%E3%83%A1%E3%82%A4%E3%83%88%E3%81%AE%E3%81%9F%E3%82%81%E3%81%ABdocstring%E3%82%92%E6%9B%B8%E3%81%93%E3%81%86

[以下はオプション]

新規性・差分

自分のdocstringの書き方として、このトークとスライドが出発点になっている👏

トークで知って試したいこと

感想