Indicate what MFA means in Gemspec/RequireMFA cop documentation

rubocop · Mar 7, 2022 · 47ec9de · 47ec9de
1 parent fed5c29
commit 47ec9de
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 7 deletions.
diff --git a/config/default.yml b/config/default.yml
@@ -262,7 +262,7 @@ Gemspec/OrderedDependencies:
     - '**/*.gemspec'
 
 Gemspec/RequireMFA:
-  Description: 'Checks that the gemspec has metadata to require MFA from RubyGems.'
+  Description: 'Checks that the gemspec has metadata to require Multi-Factor Authentication from RubyGems.'
   Enabled: pending
   VersionAdded: '1.23'
   Reference:

diff --git a/docs/modules/ROOT/pages/cops_gemspec.adoc b/docs/modules/ROOT/pages/cops_gemspec.adoc
@@ -195,9 +195,10 @@ spec.add_dependency 'rspec'
 
 Requires a gemspec to have `rubygems_mfa_required` metadata set.
 
-This setting tells RubyGems that MFA is required for accounts to
-be able perform privileged operations, such as (see
-RubyGems' documentation for the full list of privileged operations):
+This setting tells RubyGems that MFA (Multi-Factor Authentication) is
+required for accounts to be able perform privileged operations, such as
+(see RubyGems' documentation for the full list of privileged
+operations):
 
 * `gem push`
 * `gem yank`

diff --git a/lib/rubocop/cop/gemspec/require_mfa.rb b/lib/rubocop/cop/gemspec/require_mfa.rb
@@ -5,9 +5,10 @@ module Cop
     module Gemspec
       # Requires a gemspec to have `rubygems_mfa_required` metadata set.
       #
-      # This setting tells RubyGems that MFA is required for accounts to
-      # be able perform privileged operations, such as (see
-      # RubyGems' documentation for the full list of privileged operations):
+      # This setting tells RubyGems that MFA (Multi-Factor Authentication) is
+      # required for accounts to be able perform privileged operations, such as
+      # (see RubyGems' documentation for the full list of privileged
+      # operations):
       #
       # * `gem push`
       # * `gem yank`