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

Avoid generating documentation pages for internal components #1047

Merged
merged 1 commit into from
Dec 13, 2024

Conversation

st0012
Copy link
Member

@st0012 st0012 commented Dec 12, 2024

Currently, the documentation website lists most of IRB's internal classes/modules...etc.

Screenshot 2024-12-12 at 23 00 38

They're not helpful to end users and are mostly undocumented anyway. Therefore, we should avoid generating documentation for them.

Result:
Screenshot 2024-12-12 at 23 02 18

@@ -46,8 +46,6 @@ task :default => :test

RDoc::Task.new do |rdoc|
rdoc.title = "IRB"
rdoc.rdoc_files.include("*.md", "lib/**/*.rb")
rdoc.rdoc_files.exclude("lib/irb/xmp.rb")
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we use these options, .document will be ignored. Since .document will be applied to ruby/ruby's documentation generation too, we should prioritize using it.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, this is not correct. I think it'd be better if that's the case though. Will see how I can make it happen.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tompng I opened ruby/ruby#12325 for this. Can you review it there too?

lib/irb.rb Outdated Show resolved Hide resolved
@st0012 st0012 force-pushed the cleanup-documentation-files branch from 5bb2088 to da518ee Compare December 13, 2024 16:55
Copy link
Member

@tompng tompng left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@st0012 st0012 merged commit f57025a into master Dec 13, 2024
59 checks passed
@st0012 st0012 deleted the cleanup-documentation-files branch December 13, 2024 17:08
matzbot pushed a commit to ruby/ruby that referenced this pull request Dec 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.

2 participants