¿El Rubí Yard tiene una función comparable a RDoc: incluir: la etiqueta?

StackOverflow https://stackoverflow.com/questions/4501625

  •  12-10-2019
  •  | 
  •  

Pregunta

RDoc tiene: incluir: la etiqueta (ver la parte inferior de esta página ) que se llevará en un archivo de texto arbitrario y formato como si fuera una sangría dondequiera que la incluyen comienza. Esta es una gran manera de tirar en el código fuente de ejemplos de documentación.

Yard tiene una etiqueta o una función similar?

¿Fue útil?

Solución

Actualmente patio sólo es compatible con la incorporación de la documentación de otras cadenas de documentación de objetos en la forma: 

class Foo
  # Docstring here
  def method; end

  # Here is some more docs and {include:Foo#method}
  def bar; end
end

Inclusión de archivos fue vagamente previsto, pero nunca fue muy solicitada antes, así que no era de alta prioridad. Si desea abrir un tema en el http://github.com/lsegal/yard/issues - podemos estar seguros de que se le hace seguimiento y añadido para la próxima versión 0.7.0

.
Licenciado bajo: CC-BY-SA con atribución
No afiliado a StackOverflow
scroll top