jwlib

そういや autoload の doc てどういう風に書くべきかなとちょっと悩んだんだけど ( script file と同じ名前にすると他とかぶるだろうし buf#replace みたいに階層があるのできちんと構造化しないといたずらに file が増える ) 以下の方式にすることにした。

  • autoload directory 直下の名前毎にひとつ doc を書く。 autoload/buf.vim と autoload/buf/ 以下のすべての file の help は同じ doc に書かれる。
    • doc にはどの file がどんなものを提供するかと逆方向として各 function にどの file で提供されるかを書く。
  • prefix として "jwlib-" をつける。上記の例なら jwlib-buf.txt になる。
    • 単純に janus_wel の頭文字を取って "jw" と library の短縮形の "lib" をくっつけて "jwlib" 。

で、試験先行版として buf まわりについて書いてみた。大丈夫かなー。