Potential for reducing number of ri files
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Active
- Tech stack
- ruby
- Domain
- documentation
Research direction
No source files, tests, or entry points are named. Start by tracing how RDoc generates .ri files and compare the observed file counts and sizes; done means establishing whether a bundled representation is feasible and defining the scope of an implementation or follow-up proposal.
Written by the indexing model from the issue text.
Description
Is there currently a way to generate .ri files in a more bundled way to reduce the number of files generated? Or it would seem this would be an optimization worth discussing given some statistical analysis.
.ri(and.rb) files are disproportionately populous compared to other file types in a typical Homebrew installation.
cd /opt/homebrew
find . -type f | sed 's/.*\.//' | sort | uniq -c | sort -nr | head
80487 ri
10922 rb
7478 py
6551 h
5838 3
2476 html
2338 js
1765 po
1729 gz
1641 elc
- 95% of files are under 1k.
Dir['/opt/homebrew/lib/ruby/gems/4.0.0/doc/*'].each do
files = Dir["#{it}/**/*.ri"].select { File.file?(it) }
files.each { puts Math.log(File.size(it), 10).floor }
end
ri.sh | sort | uniq -c | sort -nr
66580 2
3898 3
193 4
8 5
- Some gems like RuboCop, Parser and Prism have disproportionately many files.
Dir['/opt/homebrew/lib/ruby/gems/4.0.0/doc/*'].each do
files = Dir["#{it}/**/*.ri"].select { File.file?(it) }
total = files.sum { File.size(it) } # .tap { warn Math.log(it, 10).floor }
printf "%d\t%d\t%s\n", total / 1e3, files.length, it.split('/')[8..].join('/')
end
ri.sh | sort -n
5068 8957 rubocop-1.90.0
2929 8861 parser-3.3.12.0
2544 5406 prism-1.9.0
1558 2653 language_server-protocol-3.17.0.6
1276 1539 rdoc-8.0.0
1231 2284 yard-0.9.45
1005 2110 rubygems-4.0.20
922 2463 rbs-4.2.0
914 1347 concurrent-ruby-1.3.8
888 1579 simplecov-1.2.0
- Dominant language
- Ruby
- Stars
- 930
- Forks
- 465
- Avg merge
- 3d 10h
- Merged PRs (30d)
- 27
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from ruby/rdoc
-
RDoc 8.0.0 gem omits `doc/rdoc/example.rb`, which is referenced by the packaged markup documentation Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
-
enhancement
Difficulty 4/5 3-5 days Newbie friendliness 68/100
-
Difficulty 3/5 1-2 days Newbie friendliness 68/100
-
Difficulty 3/5 1-2 days Newbie friendliness 58/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
simp/pupmod-simp-simp#395 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 80/100
simp/pupmod-simp-rsyslog#219 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
simp/pupmod-simp-pupmod#256 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
simp/pupmod-simp-sudo#150 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100