CODEWITHSUNDEEP
ruby-on-railsrubydocumentationyard
anxiety
anxiety

Reputation: 1709

YARD: how to create a link to a class method?

How do you create a link to a ruby class method with YARD? Here is the yard documentation regarding links.

Linking to an instance method within the same namespace:

{#my_instance_method}

Which works fine. However, following that same approach with a class method does not compile, and modifying it:

{#self.my_class_method}

generates the following plain text (not a link):

ObjectName#self#self.my_class_method

Upvotes: 12

Views: 2491

Answers (2)

Andrew Haines
Andrew Haines

Reputation: 6644

Just use the name, bare:

{class_method}

Or if it is in a different namespace

{Object.class_method}

Upvotes: 12

iosctr
iosctr

Reputation: 471

Use a dot.

{.class_method}

Or, if you're using markdown as a processor, you'll need to escape the underscore.

{.class\_method}

Upvotes: 4

Related Questions