You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# {Fixnum} is from StdLib, {Color::RGB} from gem color# and all of this is just an example and does not have any# practical use and these types were choosen randomly# @param [Fixnum] intensity Intensity of the gray# @return [Color::RGB] Colorvalue representing that graydefgrayintensity# do stuffend
Is there a way to let yard know about usage of these gems/namespaces and link to their documentation at RubyDoc.info?
The text was updated successfully, but these errors were encountered:
This is a great idea, but it's extremely complicated to implement for a number of reasons (where is the other doc located at, how to know which library it's referring to, what happens with monkeypatches, perf issues, etc). Unfortunately I don't see a path forward to get this into core any time soon. A plugin would be a great way to get this going without introducing the complexity into YARD core. Note that if rubydoc.info is the goal, this could also just be a layer implemented in http://github.com/docmeta/rubydoc.info directly, where we are much more relaxed about what goes into the core functionality. Also, if the plugin does become popular, pulling it into core could be a discussion.
Lets say we have some code like this:
Is there a way to let yard know about usage of these gems/namespaces and link to their documentation at RubyDoc.info?
The text was updated successfully, but these errors were encountered: