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
Just use the name, bare:
{class_method}
Or if it is in a different namespace
{Object.class_method}
Use a dot.
{.class_method}
Or, if you're using markdown as a processor, you'll need to escape the underscore.
{.class\_method}
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With