-
Notifications
You must be signed in to change notification settings - Fork 438
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
PLEASE make cross references actually work w/ ri #1097
Comments
@zenspider, I've been aware of this issue, and agree that it would be good for RDoc to do better. Meanwhile, I have been working on some enhanced documentation for |
This is unusable. Period. I don't want to "mentally translate it", I want it to work. If I'm supposed to type X to get information, then it should output X, not Y. If that means that all of the xrefs in the documentation need to be changed, then so be it. If it isn't copy/paste-able then it isn't working. |
@zenspider, fixing this is out of scope for me (primarily a documentor, not a developer); best I can do is put a workaround in the documentation. Personally, I think the cut-and-paste is also inadequate; generated RI should have maximal http(s) URLs (not rdoc-refs), which I find in several command windows are recognized as URLs and can be opened with Ctrl-click. |
I would personally regard printing URLs as a regression. The point of |
This seems like a decent approach. I was going to suggest we scaled back on the number of |
(Also, why are there 2 blank lines at the end of
File.new
output?)or:
This just isn't right.
rdoc-ref
isn't a thing yet ri refers to it ALL OVER the place. There's not the faintest clue thatruby:
is the correct prefix. Please make this tool usable again OR stop extracting the useful bits of the doco into cross referenced files that don't work.The text was updated successfully, but these errors were encountered: