[No.22] パラメータの説明機能の実装

[emuemuJP]

[ReiHashimoto]

• #505
  • 見積・検討時の内容

[ReiHashimoto]

• pynwbで使用されているデコレータ
  • https://hdmf.readthedocs.io/en/stable/hdmf.utils.html#hdmf.utils.docval
  • デコレータでパラメータを定義する
  • このデコレータを使用している関数をself, **kwargsを引数に取るようにする
  • paramsにyamlからloadしたdictを渡せばyamlの変数もドキュメントに起こせそう
    • yamlのフォーマットをname, doc, type, defaultなどのフィールドで定義するようにすればよさそう

[ReiHashimoto]

https://autodoc-pydantic.readthedocs.io/en/stable/index.html#

基本的にモデルに対するドキュメンテーション用の仕組みなので、今回のユースケースとはマッチしなそう