Non rubino Yard dispone di una funzione paragonabile a RDoc: includere: tag?

Question

RDoc ha il: include: tag (vedere il fondo di questa pagina ) che vi porterà in un file di testo arbitrario e il formato come se fosse rientrato ovunque l'inclusione inizia. Questo è un ottimo modo per tirare nel codice sorgente per gli esempi di documentazione.

Yard hanno un tag simile o funzionalità?

Answer 1

Al momento YARD supporta solo l'incorporamento documentazione da altre docstring degli oggetti nella forma:

class Foo
  # Docstring here
  def method; end

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

File di inclusione è stata vagamente prevista, ma non è mai stato realmente richiesto prima, quindi non era prioritario. Se si desidera aprire un problema su http://github.com/lsegal/yard/issues - siamo in grado di assicurarsi che viene monitorato e ha aggiunto per l'imminente rilascio 0.7.0

.