Adding documentation to methods

suggested from Pull Review

Author: travis

.pullreview.yml

@@ -0,0 +1,5 @@
+# Keeping to style of Redmine
+---
+rules:
+  ignore:
+  - simplify_call_to_render_partial

lib/issue_helper_patch.rb

@@ -16,6 +16,7 @@ def humanized_time(entry_hours)
     end
   end
 
+  # Human readable format for Hour data
   def humanized_hour(hours)
     if hours == 1
       t('plugin_spent_time_in_issue.datetime.hours.one')
@@ -26,6 +27,7 @@ def humanized_hour(hours)
     end
   end
 
+  # Human readable format for Hour minute
   def humanized_minute(minutes)
     if minutes == 1
       ' ' << t('plugin_spent_time_in_issue.datetime.minutes.one')
@@ -36,6 +38,7 @@ def humanized_minute(minutes)
     end
   end
 
+  # Time Spent value in format specified by configuration.
   def report_time_spent(entry)
     if Setting.plugin_redmine_spent_time_in_issue_description['time_format'].eql? 'human'
       humanized_time(entry.hours)

lib/setup_issue_show.rb

@@ -14,6 +14,7 @@ def initialize
     @current_version = [Redmine::VERSION::MAJOR, Redmine::VERSION::MINOR, Redmine::VERSION::TINY].join('.')
   end
 
+  # Location of file to use as Issue#show
   def show_file
     possible_files = @issues_directory.children(false).select { |files| files.to_s.index(/\d.*show/) }
     show_file = possible_files.sort { |x, y| y <=> x }.find do |file|

test/unit/setup_issue_show_test.rb

@@ -19,6 +19,7 @@ def test_show_file
     assert_equal @setup_issue_show.show_file.class, Pathname
   end
 
+  # Test the different versions of files that can be found.
   def test_correct_file_found
     @setup_issue_show.current_version = '2.3.1'
     assert_equal '2.3.1', @setup_issue_show.show_file.redmine_version, 'Did not find the exact match.'