From 59dc80274e4c90b4eb86bdcb78975734776dd9c7 Mon Sep 17 00:00:00 2001 From: Michal Filka Date: Mon, 19 Dec 2016 14:37:01 +0100 Subject: [PATCH] Added documentation --- src/lib/installation/proposal_store.rb | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/lib/installation/proposal_store.rb b/src/lib/installation/proposal_store.rb index 69a6ed543..ef6c7a4a7 100644 --- 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>/, "\\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