Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Consider letting help fall back to RI documentation

Abierto
#1,242 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Necesita aclaración
Estado de actividad
Activo
Stack tecnológico
ruby
Área
cli

Línea de trabajo

Comienza con los puntos de entrada de IRB help y show_doc; después, inspecciona cómo ShowDoc utiliza RDoc::RI::Driver. Determina si help debe redirigir a los usuarios a show_doc o mostrar directamente la documentación de RI; se considerará terminado cuando el comportamiento elegido esté implementado y cubierto por pruebas.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

I noticed that:

irb> help Array
Can't find command `Array`. Please check the command name and try again.

even though IRB can already look up the same documentation with:

irb> show_doc Array

I dug into ShowDoc a bit and saw that it uses RDoc::RI::Driver, so it seems like help could potentially make use of the same functionality.

I'm wondering if it would make sense for help to fall back to RI when the requested name isn't an IRB command.

There seem to be two reasonable ways to handle this:

help Array could tell the user to use show_doc Array.
help Array could just display the RI documentation directly, effectively making help a more general entry point for both IRB commands and Ruby documentation.

The second option seems particularly convenient, but I wasn't sure which behavior would fit better with IRB's intended interface.

Would either of these be desirable? If so, I'd be interested in taking a shot at implementing it.

Lenguaje dominante
Ruby
Estrellas
478
Forks
158
Merge medio
22 h 56 min
PR fusionados (30 d)
12

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de ruby/irb

Todos los issues de ruby/irb

Issues similares

Más issues de Ruby

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.