Added documentation

yast · Dec 19, 2016 · 59dc802 · 59dc802
1 parent 010c568
commit 59dc802
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/src/lib/installation/proposal_store.rb b/src/lib/installation/proposal_store.rb
@@ -250,6 +250,14 @@ def title_for(client)
       title.gsub(/<a.*?>(.*?)<\/a>/, "\\1")
     end
 
+    # Checks if the client's proposal is configured as "hard" or "soft" read-only
+    #
+    # "hard" read-only means that the proposal is always read-only
+    # "soft" read-only means that the proposal is made changeable when an error
+    #
+    # @return [Boolean] true if client is "hard" or "soft" read-only
+    # @see read_only_no_recovery
+    # @see read_only_with_recovery
     def read_only?(client)
       read_only_no_recovery?(client) || read_only_with_recovery?(client)
     end