From 13cb9fb48538fc7eed9b2f924aa4c84dd1434e3b Mon Sep 17 00:00:00 2001
From: intrigeri <intrigeri@boum.org>
Date: Wed, 29 Jun 2016 18:49:23 +0000
Subject: [PATCH] Move documentation to README, and expand a bit on it.

---
 README.md                 | 5 +++++
 manifests/dist_upgrade.pp | 2 --
 2 files changed, 5 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index c0d5f85..185efb0 100644
--- a/README.md
+++ b/README.md
@@ -356,6 +356,11 @@ classes may inherit from this one and add to its subscription list
 using the plusignment (`+>`) operator. A real-world example can be
 seen in the `apt::dist_upgrade::initiator` source.
 
+Parameters:
+
+ * timeout: specified in seconds; the maximum time the `dist-upgrade`
+   command should take. If the command takes longer than the timeout,
+   the command is considered to have failed and will be stopped.
 
 ## apt::dist_upgrade::initiator<a name="apt-dist_upgrade-initiator"></a>
 
diff --git a/manifests/dist_upgrade.pp b/manifests/dist_upgrade.pp
index e5475fc..3061fb8 100644
--- a/manifests/dist_upgrade.pp
+++ b/manifests/dist_upgrade.pp
@@ -1,5 +1,3 @@
-# Parameters:
-# - timeout: specified in seconds
 class apt::dist_upgrade (
   $timeout = 300,
 ) {