Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Crossreference with other libraries? #855

Closed
NobbZ opened this issue Apr 6, 2015 · 2 comments
Closed

Crossreference with other libraries? #855

NobbZ opened this issue Apr 6, 2015 · 2 comments

Comments

@NobbZ
Copy link

NobbZ commented Apr 6, 2015

Lets say we have some code like this:

# {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 gray
def gray intensity
  # do stuff
end

Is there a way to let yard know about usage of these gems/namespaces and link to their documentation at RubyDoc.info?

@phallguy
Copy link

phallguy commented Oct 3, 2015

+1

@lsegal
Copy link
Owner

lsegal commented Apr 15, 2016

Closing out old issues.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants