Hacker News Board Hacker News, browsed like a classic message board
Live data from Hacker News

Show HN: Omniref - a better search site for Ruby documentation

omniref.com

Post reply on HN
Print view View original

41–50 of 63 posts

Re: Show HN: Omniref - a better search site for Ruby documentation

#41

Post by timr »

latortuga wrote: post #36

Anyone looking for functionality like this in a local, offline reference should check out YARD[1]. I (embarrassingly) only recently set it up to serve a set of my common gems and the ruby standard lib and it works and looks great. [1] http://yardoc.org

You should be careful with YARD -- we've found a number of bugs in it that lead to broken/missing documentation. The ruby standard library, for example, is missing huge chunks of its documentation if you use YARD instead of RDoc.

I very much wanted YARD to be a drop-in replacement for RDoc, but it's not quite there yet.

Re: Show HN: Omniref - a better search site for Ruby documentation

#44

Post by timr »

JonnieCache wrote: post #39
timr wrote: post #28

Earlier quoted context omitted.

We already have all of the documentation for all of the current ruby gems, plus the ruby standard library. We don't yet have all versions of everything, but that's coming soon. AFAIK, we're already more comprehensive than the existing sites, though.

Ah. It seems that for some reason I searched by the gem name, which obviously came up with nothing.

Hm. You searched for rails, or something else?

http://www.omniref.com/?q=rails

Let us know if there's a bug.

Re: Show HN: Omniref - a better search site for Ruby documentation

#45

Post by timr »

DanielRibeiro wrote: post #43

Wow, it works with symbols: http://www.omniref.com/?q=+ http://www.omniref.com/?q=[] http://www.omniref.com/?q=- http://www.omniref.com/?q=* Quick tip: You have this tiny styling issue here: http://i.imgur.com/4uxUuPO.png

Urgh, thanks for the heads up. Making code blocks wrap correctly is non-trivial. We'll add that to the bug list.

Re: Show HN: Omniref - a better search site for Ruby documentation

#46

Post by crashandburn4 »

timr wrote: post #45
DanielRibeiro wrote: post #43

Wow, it works with symbols: http://www.omniref.com/?q=+ http://www.omniref.com/?q=[] http://www.omniref.com/?q=- http://www.omniref.com/?q=* Quick tip: You have this tiny styling issue here: http://i.imgur.com/4uxUuPO.png

Urgh, thanks for the heads up. Making code blocks wrap correctly is non-trivial. We'll add that to the bug list.

Very nice. symbol hound just isn't that great so it's good that at least rubydocs can be searched properly for that spaceship and stuff. aw, can't find the stabby lambda, but at least you've got a nice 404 page :) http://www.omniref.com/?q=-%3E

Re: Show HN: Omniref - a better search site for Ruby documentation

#47

Post by timr »

crashandburn4 wrote: post #46
timr wrote: post #45

Earlier quoted context omitted.

Urgh, thanks for the heads up. Making code blocks wrap correctly is non-trivial. We'll add that to the bug list.

Very nice. symbol hound just isn't that great so it's good that at least rubydocs can be searched properly for that spaceship and stuff. aw, can't find the stabby lambda, but at least you've got a nice 404 page :) http://www.omniref.com/?q=-%3E

We need to give more love to symbol search - most are fine, but the query analyzer doesn't do well with all combinations. We'll add that one to the bug list.

Glad someone found the 404 page, at least. ;-)

Re: Show HN: Omniref - a better search site for Ruby documentation

#50

Post by JonnieCache »

timr wrote: post #44
JonnieCache wrote: post #39

Earlier quoted context omitted.

Ah. It seems that for some reason I searched by the gem name, which obviously came up with nothing.

Hm. You searched for rails, or something else? http://www.omniref.com/?q=rails Let us know if there's a bug.

http://www.omniref.com/?q=fuzzy_match

doesnt take me to http://rubygems.org/gems/fuzzy_match

Post reply on HN