Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

robe-doc/eldoc for all methods? #23

Closed
Silex opened this issue Feb 11, 2014 · 3 comments
Closed

robe-doc/eldoc for all methods? #23

Silex opened this issue Feb 11, 2014 · 3 comments

Comments

@Silex
Copy link

Silex commented Feb 11, 2014

First of all, robe is AWESOME 👍

Now, I noticed that eldoc shows informations for stuffs like belongs_to and that robe-doc works for it. However, it doens't work for File.exists? and other basic methods, while the package yari has no problem accessing it.

Any idea?

[EDIT] ha, actually yari doesn't work for belongs_to... basically it seems one works where the other doesn't

@dgutov
Copy link
Owner

dgutov commented Feb 12, 2014

First of all, robe is AWESOME

Thanks. :)

However, it doens't work for File.exists? and other basic methods

We use the information that pry and pry-doc provide, the latter uses Yard to fetch docs for method defined in C. Most of the time it works, sometimes it doesn't, probably because it's not 100% compatible with the scanner RI uses. Make sure you have pry-doc installed, though.

They have some bugs related to the core methods documentation. In short, if you can enter Pry session and use show-doc to find the desired method's documentation but can't in Robe, that would be the bug in the latter. Otherwise, in the former. They do try to fix them, but lately it's been slow.

Some bugs I'm aware of:

pry/pry-doc#3
pry/pry-doc#15
pry/pry-doc#16

@dgutov
Copy link
Owner

dgutov commented Feb 12, 2014

actually yari doesn't work for belongs_to

It's the same for me, but that could be a problem with the activerecord gem installation (gem installed without the ri docs). This article indicates that ri works at least with some AR methods: http://danielchoi.com/software/ri-enhanced.html

@Silex
Copy link
Author

Silex commented Feb 28, 2014

This will be fixed by pry/pry#1136 and pry/pry-doc#17

@Silex Silex closed this as completed Feb 28, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants