YARD::Handlers::Ruby::MixinHandler: Undocumentable mixin: YARD::Parser::UndocumentableError


#1

I’m experimenting with replacing my home-grown value objects with dry-struct, but sadly, it seems I cannot get YARD documentation to generate. Is this something I should expect?

Here are steps to reproduce:

git clone https://github.com/bbuchalter/site_check.git
cd site_check
bin/setup
yard

And the output:

[warn]: in YARD::Handlers::Ruby::MixinHandler: Undocumentable mixin: YARD::Parser::UndocumentableError for class SiteCheck::Types
	in file 'lib/site_check/types.rb':6:

	6: include Dry::Types.module

#2

Yeah, this is expected because here .module generates a module for you on the fly. I don’t think YARD is able to handle such things but mb @solnic knows more on the subject.


#3

No I don’t :confused: