search

JuliaTokyo / julia-wakalang

Juliaのわからないことへの質問を雑にする場所
MIT License
25 stars 3 forks source link

ドキュメントを文字列として取得したい #20

Closed machakann closed 6 years ago

machakann commented 6 years ago

REPL の help モードで出力されるドキュメント (help?> {keyword}) を文字列で取得する方法はないでしょうか？

動機としては編集中にエディタの中でドキュメントをチェックしたい、というものなので文字列で取得できなくとも標準出力あたりに出してくれれば取れそうな気がします。昔のバージョン (0.3 ぐらい?) には help() って関数があった気がするんですがなくなったみたいです。

yomichi commented 6 years ago

ret = @doc sin とかやれば取得できます。 返ってくるのはただのString ではない（Base.Markdown.MD）ですが、とりあえず v0.6 なら ret.content とすれば String になります。

machakann commented 6 years ago

ありがとうございます、やりたかったことができそうです。

machakann commented 6 years ago

merge されるかわかりませんが、成果物です。 Vim を使っているので簡単にドキュメントを引けるような PR をおくりました。

https://github.com/JuliaEditorSupport/julia-vim/pull/139

bicycle1885 commented 6 years ago

すばらしい！

machakann commented 6 years ago

上の PR が紆余曲折を経て merge されました 🎉