Skip to content

Comments

Document :concurrent_downloads in gem environment config docs (follow-up to #9339)#9341

Merged
colby-swandale merged 2 commits intoruby:masterfrom
afurm:docs-concurrent-downloads-command-reference
Feb 20, 2026
Merged

Document :concurrent_downloads in gem environment config docs (follow-up to #9339)#9341
colby-swandale merged 2 commits intoruby:masterfrom
afurm:docs-concurrent-downloads-command-reference

Conversation

@afurm
Copy link
Member

@afurm afurm commented Feb 20, 2026

What was the end-user or developer problem that led to this PR?

In #9339, concurrent_downloads was fixed so .gemrc values are honored.
However, the .gemrc key list shown by gem environment still did not mention :concurrent_downloads, which can make users think it is not a supported config key.

Since this text is used for command documentation (including the command reference), this needs a separate docs-focused PR.

What is your fix for the problem, implemented in this PR?

This PR updates Gem::Commands::EnvironmentCommand#description to include:

  • :concurrent_downloads: The number of gem downloads to perform concurrently

It also adds a regression test to ensure the description continues to mention this key:

  • test_description_mentions_concurrent_downloads in test/rubygems/test_gem_commands_environment_command.rb

I chose this minimal approach because it directly updates the command’s canonical help text and adds test coverage to prevent future drift.

Make sure the following tasks are checked

Copy link
Member

@colby-swandale colby-swandale left a comment

Choose a reason for hiding this comment

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

Nice one! Much appreciated.

@colby-swandale colby-swandale merged commit da1333f into ruby:master Feb 20, 2026
107 of 109 checks passed
@afurm afurm deleted the docs-concurrent-downloads-command-reference branch February 20, 2026 11:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants