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

Expand rdoc-ref targets at the end of ri output #1141

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

st0012
Copy link
Member

@st0012 st0012 commented Jul 15, 2024

There have been several document refactors in ruby/ruby that extract individual methods/classes' documentation into separate files, like ruby/ruby#6567

Because RI is not capable of rendering those references, RI users are left with dramatically fewer documentation on those methods/classes.

This commit adds a new option --expand-ref (default: true) to expand all the rdoc-ref targets at the end of the output.

Closes #1097

There have been several document refactors in ruby/ruby that extract
individual methods/classes' documentation into separate files, like
ruby/ruby#6567

Because RI is not capable of rendering those references, RI users
are left with dramatically fewer documentation on those methods/classes.

This commit adds a new option `--expand-ref` (default: true) to expand
all the rdoc-ref targets at the end of the output.
@adam12
Copy link
Contributor

adam12 commented Jul 15, 2024

Tested this on a few core/stdlib methods and it worked well! 👍

@adam12
Copy link
Contributor

adam12 commented Jul 30, 2024

One issue that's not directly related but should be worth noting is it fails to work on [#module-JSON-label-Parsing+Options].

I know it doesn't start with rdoc-ref but it appears to be a valid reference at least on the HTML generated site.

(the example is from JSON.parse, by the way).

@zenspider
Copy link
Contributor

Might be valid... but it might need to be changed just to fit this PR. Frankly I don't care as long as ri Array#pack works... But I do agree that xrefs for options NEED to be expanded sooner or later. Getting doco that says **opts and then has a broken xref you can't actually use isn't helping ANYONE.

@st0012 st0012 added this to the v6.8.0 milestone Oct 17, 2024
@st0012 st0012 modified the milestones: v6.8.0, v7.0.0 Nov 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

PLEASE make cross references actually work w/ ri
3 participants