Shougo / context_filetype.vim

Context filetype library for Vim script
Other
160 stars 20 forks source link

ドキュメント修正 #12

Closed syngan closed 11 years ago

syngan commented 11 years ago

g:context_filetype#filetypes の filetype に \1 がつかえることの説明がなかったので追記しました。

あとドキュメントで気になるのは、以下の2か所ですが修正方法がわかりませんでした。

osyo-manga commented 11 years ago

ありがとうございます。

g:context_filetype#filetypes : 「searchpos...」 と内部の実装方法で説明されても使う人にはわかりません。

これは g:context_filetype#search_offset の事でしょうか? Vim script の組み込み関数である searchpos() の引数 {stopline} に使用されるという意味で書いたのですがわかりづらかったですかね…。

context_filetype#version() : Note の意味が分かりません。インストールされていない場合にも正常に動作するのでしょうか?

この説明だとちょっとわかりづらいので修正しておきます。

syngan commented 11 years ago

これは g:context_filetype#search_offset の事でしょうか?

そです。すいません。

Vim script の組み込み関数である searchpos() の引数 {stopline} に使用されるという意味で書いたのですがわかりづらかったですかね…。

(ソース見たのでわかっていますが) searchpos() がどう呼ばれるかはユーザ(少なくとも私)にはわからないと思います。 searchpos() がこの関数内でどう使われるかを説明しているならいいと思いますが。

osyo-manga commented 11 years ago

少し改良してみました。 https://github.com/Shougo/context_filetype.vim/commit/8ad257c87006d4ef428e00b9e80b9a5f588a338e

syngan commented 11 years ago

素敵です。 silent! すればエラーメッセージださずに使えるんですね。

(別件ですが、vim-precious がとても素敵)

osyo-manga commented 11 years ago

silent! すればエラーメッセージださずに使えるんですね。

Yes. まぁここら辺はいくつか書き方があったりするのですが(try~catch とか。

(別件ですが、vim-precious がとても素敵)

:)