comment site_author_hash

kandra-id · Aug 22, 2017 · a59b596 · a59b596
1 parent f789998
commit a59b596
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/lib/jekyll-seo-tag/drop.rb b/lib/jekyll-seo-tag/drop.rb
@@ -246,6 +246,10 @@ def author_hash(author_string)
         site_author_hash(author_string) || { "name" => author_string }
       end
 
+      # Given a string representing the current document's author, attempt
+      # to retrieve additional metadata from site.data.authors, if present
+      #
+      # Returns the author hash
       def site_author_hash(author_string)
         return unless site.data["authors"] && site.data["authors"].is_a?(Hash)
         author_hash = site.data["authors"][author_string]