[#122258] [Ruby Misc#21367] Remove link to ruby-doc.org from www.ruby-lang.org/en/documentation/ — "p8 (Petrik de Heus) via ruby-core" <ruby-core@...>
Issue #21367 has been reported by p8 (Petrik de Heus).
11 messages
2025/05/23
[ruby-core:122207] [Ruby Misc#21350] Bundled gems lack online documentation
From:
"osyoyu (Daisuke Aritomo) via ruby-core" <ruby-core@...>
Date:
2025-05-20 13:16:39 UTC
List:
ruby-core #122207
Issue #21350 has been updated by osyoyu (Daisuke Aritomo). I also don't think the documentation for bundled gems necessarily has to be included in the Ruby core documentation, as long it is easily accessible from it. If possible, how about creating a link-to-documentation-only entry for classes provided by bundled gems (like `CSV`) ? That way, users could search for `csv` in the sidebar and find a pointer. Perhaps uploading the generated HTML to some place under `docs.ruby-lang.org`, say `docs.ruby-lang.org/gems/csv` could make it look more "official". ---------------------------------------- Misc #21350: Bundled gems lack online documentation https://bugs.ruby-lang.org/issues/21350#change-113356 * Author: osyoyu (Daisuke Aritomo) * Status: Open ---------------------------------------- Libraries which have been converted into bundled gems seem to have no online documentation. For example, `csv` had its documentation inside docs.ruby-lang.org up to Ruby 3.3: https://docs.ruby-lang.org/en/3.3/CSV.html but after it has turned into a bundled gem, there is no online documentation (try searching in https://docs.ruby-lang.org/en/3.4/). This is the case for all bundled gems, including major modules such as `Base64` (missing since 3.4 docs) and `Logger` (missing since master docs). Given that these libraries are still `require`able without any special installation, it would be nice to have their documentation on docs.ruby-lang.org (or somewhere online reachable from Google). -- https://bugs.ruby-lang.org/ ______________________________________________ ruby-core mailing list -- ruby-core@ml.ruby-lang.org To unsubscribe send an email to ruby-core-leave@ml.ruby-lang.org ruby-core info -- https://ml.ruby-lang.org/mailman3/lists/ruby-core.ml.ruby-lang.org/