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.

Sign up for GitHub

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

Jump to bottom

The documentation for the bundled gem has not been updated #2258

Open
ksss opened this issue Jan 27, 2025 · 3 comments
Open

The documentation for the bundled gem has not been updated #2258

ksss opened this issue Jan 27, 2025 · 3 comments

Comments

@ksss
Copy link
Collaborator

ksss commented Jan 27, 2025 •
edited
Loading

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
@ParadoxV5
Copy link
Contributor

  • 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?

@ksss
Copy link
Collaborator Author

ksss commented Jan 28, 2025 •
edited
Loading

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.

ksss added a commit to ksss/gem_rbs_collection that referenced this issue Feb 1, 2025
@ksss
Add minitest
ffa7ddc 
See also ruby/rbs#2258
ksss added a commit to ksss/gem_rbs_collection that referenced this issue Feb 2, 2025
@ksss
Move minitest from rbs/stdlib
ce6971e 
See also:
- ruby/rbs#2258
- ruby/rbs#1009
- ruby/rbs#1694
- ruby/rbs#2093

Thank you:
- @ksss
- @stevegeek
ksss added a commit to ksss/gem_rbs_collection that referenced this issue Feb 2, 2025
@ksss
Move net-smtp from rbs/stdlib
a09c662 
See also:
- ruby/rbs#2258
- ruby/rbs#1560

Thank you:
- @tk0miya
ksss added a commit to ksss/gem_rbs_collection that referenced this issue Feb 2, 2025
@ksss
Move base64 from rbs/stdlib
0fc4e8c 
See also:
- ruby/rbs#2258
ksss added a commit to ksss/gem_rbs_collection that referenced this issue Feb 2, 2025
@ksss
Move bigdecimal from rbs/stdlib
3056837 
See also:
- ruby/rbs#2258
- ruby/rbs#817
- ruby/rbs#936
- ruby/rbs#1053

Thank you:
- @ybiquitous
- @takahashim
- @piotaixr
ksss added a commit to ksss/gem_rbs_collection that referenced this issue Feb 2, 2025
@ksss
Move bigdecimal-math from rbs/stdlib
fde297c 
Since gem_rbs_collection is managed by gem names,
we cannot create a separate directory named bigdecimal-math.
For now, I will merge it into bigdecimal.

See also:
- ruby/rbs#2258

Thank you:
- @mihyaeru21
ksss added a commit to ksss/gem_rbs_collection that referenced this issue Feb 2, 2025
@ksss
Move abbrev from rbs/stdlib
c455ec4 
See also:
- ruby/rbs#2258
ksss added a commit to ksss/gem_rbs_collection that referenced this issue Feb 2, 2025
@ksss
Move nkf from rbs/stdlib
f4e03df 
See also:
- ruby/rbs#2258
- ruby/rbs#873

Thank you:
- @fabon-f
ksss added a commit to ksss/gem_rbs_collection that referenced this issue Feb 2, 2025
@ksss
Move csv from rbs/stdlib
04090a6 
See also:
- ruby/rbs#2258
- ruby/rbs#2099
- ruby/rbs#2012
- ruby/rbs#2003
- ruby/rbs#1903
- ruby/rbs#1864
- ruby/rbs#1738
- ruby/rbs#241

Thank you:
- @euglena1215
- @aki19035vc
- @tk0miya
- @m11o
- @connorshea
ksss added a commit to ksss/gem_rbs_collection that referenced this issue Feb 2, 2025
@ksss
Move observer from rbs/stdlib
bcd09b5 
See also:
- ruby/rbs#2258
@ksss ksss mentioned this issue Feb 2, 2025
Open
@ksss
Copy link
Collaborator Author

ksss commented Feb 2, 2025

TODO

  • [] Add bundled gems to gem_rbs_collection
  • [] Remove bundled gems from rbs/stdlib and add gems to RBS::Collection::Config::LockfileGenerator::ALUMNI_STDLIBS

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ksss @ParadoxV5