psychoslave / englishest

A Ruby gem which allows a more literate coding style
MIT License
0 stars 0 forks source link

Investigate a way to make externalized rdoc as flat as possible, preferably a solution that matches Rubocop defaults requirements #9

Open psychoslave opened 2 years ago

psychoslave commented 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.

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.

References