2013-04-22 2 views
4

저는 YARD로 문서화하고있는 첫 번째 보석을 쓰고 있습니다. 내 클래스 중 하나가 인수를 취하지 않는 블록을 예상하는 생성자를 만들었습니다 .문서 블록에 매개 변수가 없습니다

YARD는 메서드가 전달할 매개 변수의 측면에서 블록 인수를 설명하지만 params 목록이 비어 있으면 올바르게 형식을 지정하지 않습니다. 매개 변수없이 블록을 어떻게 문서화해야합니까?

: 기술적으로, 나는 심지어 yield 블록에 속해 있지 않다. I는 다음과 같습니다 코드가 있습니다

def initialize(&block) 
    define_singleton_method(:create, block) 
    create 
    class << self; undef_method :create; end 
end 

을 ... 그래서 블록이 새로 생성 된 객체의 컨텍스트에서 실행되는 코드가 포함되어 있습니다. 어떤 이유로 든 이것이 끔찍한 생각이라면, 나는 그것을 알고 기뻐할 것입니다.

+0

편집을 위해 @sawa에게 감사하지만 질문은 주로 블록 사용 패턴이 아닌 YARD 문서에 대한 것입니다. – Chowlett

답변

1

YARD의 github 페이지에서 old issue을 발견했습니다. 매개 변수 블록이 생략되어야하는 것처럼 보입니다 :

관련 문제