diff --git a/lib/linguist/language.rb b/lib/linguist/language.rb index 11d7b0de..062a506a 100644 --- a/lib/linguist/language.rb +++ b/lib/linguist/language.rb @@ -3,6 +3,10 @@ require 'linguist/lexer' require 'yaml' module Linguist + # Langage names that are recognizable by GitHub. Defined languages + # can be highlighted, searched and listed under the Top Languages page. + # + # Langages are defined in `lib/linguist/langages.yml`. class Language @languages = [] @name_index = {} @@ -62,7 +66,7 @@ module Linguist language end - # Public: Get all Languages + # Internal: Get all Languages # # Returns an Array of Languages def self.all diff --git a/lib/linguist/languages.yml b/lib/linguist/languages.yml index e54764ae..ca350b68 100644 --- a/lib/linguist/languages.yml +++ b/lib/linguist/languages.yml @@ -3,7 +3,7 @@ # lexer - An explicit lexer String (defaults to name.downcase) # aliases - An Array of additional aliases (implicitly # includes name.downcase) -# ext - An Array of associated extensions +# extension - An Array of associated extensions # searchable - Boolean flag to enable searching (defaults to true) # search_term - Deprecated: Some langauges maybe indexed under a # different alias. Avoid defining new exceptions.