Как я могу перечислить недокументированные модули / классы / константы / методы с yardoc? - PullRequest
41 голосов
/ 22 апреля 2011

У меня есть небольшая библиотека кода, которую я документирую с YARD .Когда я запускаю команду yardoc, она говорит мне:

Files:          40
Modules:        14 (    0 undocumented)
Classes:        39 (    0 undocumented)
Constants:      21 (    4 undocumented)
Methods:       239 (   31 undocumented)
 88.82% documented

Вместо того, чтобы пробираться по всему моему коду, чтобы найти недокументированные константы и методы, я хочу просто перечислить недокументированные элементы.Кто-нибудь знает, как это сделать?

Ответы [ 2 ]

44 голосов
/ 22 апреля 2011

Вы можете специально перечислить все недокументированные объекты (и их местоположение в файле) с помощью опции --list-undoc.

yard stats --list-undoc

или даже

yard --list-undoc
26 голосов
/ 21 мая 2011

Это также смутило меня.Параметр --list-undoc фактически определяется командой stats.Кроме того, команда yard, а не yardoc, что сокращенно для yard doc.

yard stats --list-undoc
...