Adding documentation to Translations class

sas1ni69 · Sep 20, 2016 · 4a8ebf4 · 4a8ebf4
1 parent eb4ba56
commit 4a8ebf4
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/lib/countries/translations.rb b/lib/countries/translations.rb
@@ -1,4 +1,9 @@
 module ISO3166
+  # Extend the hash class to allow locale lookup fall back behavior
+  #
+  # ex:
+  # if a country has translations for pt, and the user looks up `pt-br` fallback
+  # to `pt` to prevent from showing nil values
   class Translations < Hash
     def [](locale)
       super(locale) || super(locale.sub(/-.*/, ""))