Summary
The :doc: modifier forces a method to be documented, but the inline modifier text currently leaks into the rendered markdown description.
Reference
RDoc Markup reference: https://www.mikeperham.com/wp-content/uploads/2010/12/rdoc.html
Example source
class DirectiveProbe
# hidden helper # :doc:
def helper; end
end
Current markdown output
#### `helper()`
hidden helper # :doc:
Expected behavior
The method should be documented because of :doc:, but the rendered description should not include the modifier text.
#### `helper()`
hidden helper
Summary
The
:doc:modifier forces a method to be documented, but the inline modifier text currently leaks into the rendered markdown description.Reference
RDoc Markup reference: https://www.mikeperham.com/wp-content/uploads/2010/12/rdoc.html
Example source
Current markdown output
#### `helper()` hidden helper # :doc:Expected behavior
The method should be documented because of
:doc:, but the rendered description should not include the modifier text.#### `helper()` hidden helper