From bee9f7b34dbd9af396d49b917ff3344f933b304d Mon Sep 17 00:00:00 2001
From: George Dietrich <george@dietrich.app>
Date: Thu, 24 Dec 2020 10:11:41 -0500
Subject: [PATCH] Add note about strict arg

---
 src/abstract_negotiator.cr | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/abstract_negotiator.cr b/src/abstract_negotiator.cr
index 6c014e2..dd72401 100644
--- a/src/abstract_negotiator.cr
+++ b/src/abstract_negotiator.cr
@@ -11,6 +11,8 @@ abstract class Athena::Negotiation::AbstractNegotiator(HeaderType)
 
   # Returns the best `HeaderType` type based on the provided *header* value and *priorities*.
   #
+  # If *strict* is `true`, an `ANG::Exceptions::Exception` will be raised if the *header* contains an invalid value, otherwise it is ignored.
+  #
   # See `Athena::Negotiation` for examples.
   def best(header : String, priorities : Indexable(String), strict : Bool = false) : HeaderType?
     raise ArgumentError.new "priorities should not be empty." if priorities.empty?