rbs
rbs copied to clipboard
ruby
The documentation for the bundled gem has not been updated
The rake annotation task generates documentation for RBS from the ruby/ruby source code. However, bundled gems are not included in the ruby/ruby source code. As a result, the rake annotate task that updates documentation does not update the documentation for bundled gems.
I think we need to decide on how to approach the documentation for bundled gems.
- minitest
- net-smtp
- base64
- bigdecimal
- abbrev
- nkf
- csv
- observer
- Ruby core: We supply their RBS in RBS-gem.
- Non-bundled gems: Their RBS are either self-managed or, less ideally, community-managed at ruby/gem_rbs_collection.
Default and bundled gems needs to pick a side.
I personally prefer both to self-manage RBS in their own packages.
- Separate repositories for default gems was a relatively new convention that doesn’t quite apply de facto.
- Bundled gems are not tied to ruby/ruby though, so maybe it makes sense for the RBS to rather be in gem_rbs_collection at least for the time beïng, considering the uninstallation these (helpful!) bundleware isn’t restricted?
I discussed with the committers (@soutaro @pocke @mame) and decided on the following policy.
- Move RBS of Bundled gem to gem_rbs_collection.
- Move to gem if management by gem is approved.
- Deprecation warning if it is written in manifest.yaml.
TODO
- [x] Add bundled gems to gem_rbs_collection
- [x] Add gems to
RBS::Collection::Config::LockfileGenerator::ALUMNI_STDLIBS - [ ] Remove bundled gems from rbs/stdlib