Skip to content

Do not render inline :doc: modifiers in method descriptions #57

Description

@skatkov

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions