kiwanami
commented
10 years ago 手っ取り早くという事で、日本語のissue、いいと思います！ @tkf さん、いつもありがとうございます。
docstringにリッチに書くのは嫌いではないです。Javadocもたくさん書いて来ましたし、文芸的プログラミングも方針としては好きです。（ソースコードという一次元的なシリアライズフォーマットが悪いのであって、Symbolのスロット的にいろいろ入れられる仕組みだといいのかなと思います。） sphinxcontrib-emacs、もうかなり普通に動いているようですので、このまま使ってもいいかなと思っては居ます。mdもrstも、普通にテキストで見てもhtmlほどは気持ち悪くないと思っていますが、 問題があるとすればemacsのhelpとかautocompleteのdocオーバーレイで見てどうかという問題ぐらいでしょうか。
あと、@kozo2 さんも触れられていましたが、気になるのは言語の切り替えのところです。 APIはかなり安定してきているので、別管理でもいいんですが、なにかいい方法があればいいなと。
マージ方針については、 @tkf さんの方針で良いと思います。 そうすると、cherry-pick する必要があるのかな。
なかなか時間がなくて、とりあえずのコメントでした。 docstringを書き直すコストをちょっと考えてみます。
tkf
16 に関する議論ですが、 twitter でやるより日本語でも良いから issue にでやったほうが便利じゃないかと思ったのでこっちに作ってみましたがどうでしょう？ twitter のほうが良いですか？
放っておくとマージが辛くなりそうなので、決めたほうが良いと思うこと (後の方に書いてますが、 sphinxcontrib-emacs の現状にかなり左右されると思います)：
16 のマージを sphinxcontrib-emacs のリリースまで待つかどうか。
sphinxcontrib-emacs の現状なんですが、 ttps://github.com/flycheck/sphinxcontrib-emacs/issues/12 (←2chっぽい) で議論した感じだと、「ReST マークアップに
*Help*を組み合わせる案、良いと思ったんだけど色々問題出てきてやっぱやめようか迷ってる。ReSTの処理系を色々弄って実験してる最中だし忙しいし、リリースまだまだ遠いかも。」みたいな感じらしいです。ad147a36b752c73fc9607bd47bb7498d1bf3e134 や 1814a40a49fe043ca24361a08fbb4196cde71f2c で提案した docstring のテンプレートは ReST にかなり依存した書き方になっているんで、 sphinxcontrib-emacs が 「ReST やっぱり辞める。ごめんね。」ってなった場合に、大規模な docstring のスタイル変更が必要になります。doc/requirements.txt で書いてあるように github 経由で必要な sphix module をインストールしているんですが、最悪リビジョンを指定して使い続けることもできるんで、このまま移行してしまうという方法も一応考えられます。 docstring が充実するという意味では、 Emacs hacker な人たち的にはプラスだと思いますが、二度手間になる可能性があるのを考えるとあまり推してしまってはまずいかな、とも思います。
私の提案としては、こんな感じです（楽さを重視）：
16 は docstring 以外のドキュメントの移行が終了次第マージ。