Open psychoslave opened 2 years ago
Currently Rubocop is configured with
Lint/EmptyClass: AllowComments: true
This is because otherwise lib/documentation.rb will trigger complaints about empty classes, that only contain documentation coded as Rdoc comments.
lib/documentation.rb
It would be nice to have a way to document these information that:
#
Note on the later point that it's exclude the =BEGIN rdoc as Rubocop defaults doesn't like it.
=BEGIN rdoc
Currently Rubocop is configured with
This is because otherwise
lib/documentation.rb
will trigger complaints about empty classes, that only contain documentation coded as Rdoc comments.It would be nice to have a way to document these information that:
#
comment operatorNote on the later point that it's exclude the
=BEGIN rdoc
as Rubocop defaults doesn't like it.References