Bug 174923
| Summary: | No documention for "Kernel" in ruby-ri (the primary doc system for Ruby) | ||
|---|---|---|---|
| Product: | [Fedora] Fedora | Reporter: | Wayne Walker <wwalker> |
| Component: | ruby | Assignee: | Akira TAGOH <tagoh> |
| Status: | CLOSED ERRATA | QA Contact: | Bill Huang <bhuang> |
| Severity: | medium | Docs Contact: | |
| Priority: | medium | ||
| Version: | 4 | ||
| Target Milestone: | --- | ||
| Target Release: | --- | ||
| Hardware: | All | ||
| OS: | Linux | ||
| Whiteboard: | |||
| Fixed In Version: | 1.8.4-1.fc4 | Doc Type: | Bug Fix |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2006-01-06 03:53:53 UTC | Type: | --- |
| Regression: | --- | Mount Type: | --- |
| Documentation: | --- | CRM: | |
| Verified Versions: | Category: | --- | |
| oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | |
| Cloudforms Team: | --- | Target Upstream Version: | |
| Embargoed: | |||
this issue will be fixed in 1.8.4-1.fc4. From User-Agent: XML-RPC ruby-1.8.4-1.fc4 has been pushed for FC4, which should resolve this issue. If these problems are still present in this version, then please make note of it in this bug report. |
Description of problem: No "ri" documentation for Kernel Kernel is one of the most Basic object classes in Ruby. It's used extensively. "ri" is the Ruby equivalent of "man" or "perldoc", so this is needed. Version-Release number of selected component (if applicable): ri-1.8.3-2.fc4 How reproducible: always Steps to Reproduce: 1. ri Kernel 2. ri Object 3. Actual results: ---------------------------------------------------------- Class: Kernel (no description...) ------------------------------------------------------------------------ Expected results: ---------------------------------------------------------- Class: Kernel (no description...) ------------------------------------------------------------------------ Instance methods: ----------------- Array, Float, Integer, String, URI, `, abort, at_exit, autoload, autoload?, binding, block_given?, callcc, caller, catch, chomp, chomp!, chop, chop!, eval, exec, exit, exit!, fail, fork, format, getc, gets, global_variables, gsub, gsub!, iterator?, lambda, load, local_variables, loop, method_missing, open, p, print, printf, proc, putc, puts, raise, rand, readline, readlines, require, scan, select, set_trace_func, sleep, split, sprintf, srand, sub, sub!, syscall, system, test, throw, trace_var, trap, untrace_var, warn, y Additional info: The rdoc system will fail to generate _any_ docs for a module, if _any_ module line for the module has a :nodoc: comment. One was erroneously put in lib/yaml.rb. This is fixed in the next (as yet unreleased) ruby release. As many of the important methods of ruby are documented under Kernel, it's quite important for Kernel to have docs. Here is the patch difference from 1.8.3 to the prerelease 1.8.4. The one line change would fix this large hole in ruby docs in FC4. [ (0) wwalker@behemoth:~/work ]$ diff -Naur ruby-1.8.[34]/lib/yaml.rb --- ruby-1.8.3/lib/yaml.rb 2005-09-20 04:22:01.000000000 -0500 +++ ruby-1.8.4/lib/yaml.rb 2005-11-06 09:09:06.000000000 -0600 @@ -1,5 +1,5 @@ # -*- mode: ruby; ruby-indent-level: 4; tab-width: 4 -*- vim: sw=4 ts=4 -# $Id: yaml.rb,v 1.9.2.10 2005/09/20 09:22:01 matz Exp $ +# $Id: yaml.rb,v 1.9.2.11 2005/11/06 15:09:06 ocean Exp $ # # = yaml.rb: top-level module with methods for loading and parsing YAML documents # @@ -392,7 +392,7 @@ require 'yaml/rubytypes' require 'yaml/types' -module Kernel # :nodoc: +module Kernel # # ryan:: You know how Kernel.p is a really convenient way to dump ruby # structures? The only downside is that it's not as legible as