fix missing comments for new code

yast · Nov 25, 2014 · 8b9345c · 8b9345c
1 parent 9295b8a
commit 8b9345c
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 1 deletion.
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -117,7 +117,8 @@ Style/CaseIndentation:
 
 # Offense count: 42
 Style/Documentation:
-  Enabled: false
+  Include:
+    - 'src/lib/**/*.rb' # force well documented code only for new code
 
 # Offense count: 52
 # Cop supports --auto-correct.

diff --git a/src/lib/bootloader/device_map_dialog.rb b/src/lib/bootloader/device_map_dialog.rb
@@ -8,6 +8,7 @@
 require "bootloader/device_map"
 
 module Bootloader
+  # Represents dialog for modification of device map
   class DeviceMapDialog
     include Yast::UIShortcuts
     include Yast::I18n

diff --git a/src/lib/bootloader/grub2base.rb b/src/lib/bootloader/grub2base.rb
@@ -4,6 +4,7 @@
 require "bootloader/udev_mapping"
 
 module Yast
+  # Common base for GRUB2 specialized classes
   class GRUB2Base < Module
     def main
       Yast.import "UI"

diff --git a/src/lib/bootloader/grub2pwd.rb b/src/lib/bootloader/grub2pwd.rb
@@ -1,5 +1,6 @@
 require "yast"
 
+# class is responsible for detection, encryption and writing of grub2 password protection
 class GRUB2Pwd
   YAST_BASH_PATH = Yast::Path.new(".target.bash_output")
   PWD_ENCRYPTION_FILE = "/etc/grub.d/42_password"