我可以用pry查看Rails文档吗?

时间:2014-11-24 20:39:40

标签: ruby-on-rails pry

是否可以使用pry查看/浏览Rails文档?怎么样?

(pry-rails似乎是项目源,pry-doc涵盖Core Ruby。)

ri是Rails首选的本地文档浏览工具吗?

谢谢!

1 个答案:

答案 0 :(得分:2)

Pry只会向您显示已明确加载的依赖项的文档。获取所有Rails依赖项的最简单方法是在Rails项目的目录中运行pry,如下所示:

pry -r ./config/environment

现在,您已准备好通过pry查看Rails的内部文档。但是,正如您所指出的那样,Rails的文档是用ri编写的。因此,如果您运行show-doc而不是使用ri ActiveRecord::Base,则应该看到:

ActiveRecord::Base < Object

------------------------------------------------------------------------------
Includes:
(from gem activerecord-4.1.1)
  Core
  Persistence
  NoTouching
  ReadonlyAttributes
  ModelSchema
  Inheritance
  Scoping
  Sanitization
  AttributeAssignment
  ActiveModel::Conversion
  Integration
  Validations
.... it eventually gets to the actual documentation but you get the idea ...

(我认为show-doc不适用于ActiveRecord::Base,因为该文件的源代码中有#:nodoc:指令。也许有人可以在评论中插入或添加编辑。)< / p>

或者,您可以手动加载所需的每个依赖项。如果您打开了正常的pry会话并运行require 'active_record',则相同的ri命令将起作用。

如果您使用pry-rails gem或自定义初始化程序将pry设置为默认REPL,这也适用于rails控制台。