rubydocs/app

Add arel to projects

mdesantis opened this issue · 3 comments

mdesantis commented

Hey there,

firstly I want to say thank you for your docs, they're a must for me!

I use arel a lot and browsing its docs on rubydocs.info is a nightmare for the latency spikes it has. Do you think is it possible to add it to the supported projects? I could even try to create a PR if you are willing to accept it.

Cheers!

manuelmeurer commented

Thanks, @mdesantis! 😄

Arel is part of Rails AFAICS, so you should be able to find all Arel docs in the Rails docs, e.g. here: https://rubydocs.org/d/rails-6-0-3/

mdesantis commented

@manuelmeurer oh, I see... so I guess there is an hidden docs issue, that's why I can't find the Arel methods on rubydocs.org but I can on rubydoc.info. For comparison:

Do you think it's fixable, or we are doomed to have silent docs? 🤫 😆

EDIT yeah I guess it depends by this # :nodoc: all spread all around Arel... I'm lucky rubydocs.info ignore them! https://github.com/rails/rails/blob/9b6f7d7f547e22e73f3127999b154a3bab3ff14e/activerecord/lib/arel/select_manager.rb#L3

manuelmeurer commented

Yeah, that's probably it. :(