Added documentation

src/lib/installation/proposal_runner.rb

@@ -365,6 +365,11 @@ def submod_ask_user(input)
       workflow_sequence
     end
 
+    # Checks if given proposal map contains an error report
+    #
+    # @param [Hash] proposal map as returned by make_proposal
+    # @return [Boolean] true if the map reports an issue in proposal
+    # @see ProposalClient#make_proposal
     def proposal_failed?(proposal)
       proposal && [:blocker, :fatal, :error].include?(proposal["warning_level"])
     end

src/lib/installation/proposal_store.rb

@@ -325,6 +325,10 @@ def client_for_link(link)
       matching_client.first
     end
 
+    # Reads read-only proposals from the control file
+    #
+    # @return [Hash] map with keys :hard and :soft. Values are names
+    # of proposals with "hard" or "soft" read_only flag set.
     def read_only_proposals
       return @read_only_proposals if @read_only_proposals