From f4ca82011f9fd5a4c116246c7dab4a0b47926df0 Mon Sep 17 00:00:00 2001
From: Holger Just <hello@holgerjust.de>
Date: Fri, 4 Aug 2017 16:05:36 +0200
Subject: [PATCH] Add documentation for Rackstash.severity_label

---
 lib/rackstash.rb | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/lib/rackstash.rb b/lib/rackstash.rb
index 0f50977..135797b 100644
--- a/lib/rackstash.rb
+++ b/lib/rackstash.rb
@@ -45,6 +45,13 @@ module Rackstash
     'ANY'.freeze
   ].freeze
 
+  # Gets the label for a given severity. You can specify the severity either by
+  # its numeric value or its name in most variations (`Symbol`, `String`,
+  # different cases).
+  #
+  # @param severity [Integer, #to_s] A numeric value of one of the {SEVERITIES}
+  #   or a {SEVERITY_NAMES} key
+  # @return [String] one of the {SEVERITY_LABELS}
   def self.severity_label(severity)
     if severity.is_a?(Integer)
       return SEVERITY_LABELS.last if severity < 0