sanger / warren

Gem to handle rabbitMQ integrations

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

DPL-nnn [BUG] Warren::Handler::Test documentation is hard to read

JamesGlover opened this issue · comments

Describe the bug
The rubydoc.info docs https://rubydoc.info/gems/sanger_warren/Warren/Handler/Test are generating an iframe for each of the useful methods section. This is clunky and hard to read. If there isn't a nice way of inlining the documentation for each method here, links would be preferable.

To Reproduce
Steps to reproduce the behaviour:

  1. Visit https://rubydoc.info/gems/sanger_warren/Warren/Handler/Test
  2. Observe hard to read documentation

Expected behaviour
The methods in Making assertions should be easy to read, and not be obviously inline frames repeating content just down the page. Basic links might be fine, or even losing the section entirely, after all, it is all just a little further down the page.

Screenshots
Screenshot 2021-07-27 at 14 18 52