Add documentation for where the commit_message parameters are passed and where they're source from

2012-09-16 15:59:49 +01:00
parent ae4b1cdeca
commit 7dee787a92
1 changed files with 6 additions and 0 deletions
@@ -371,6 +371,12 @@ module Precious

    private

+    # Options parameter to Gollum::Committer#initialize
+    #     :message   - The String commit message.
+    #     :name      - The String author full name.
+    #     :email     - The String email address.
+    # message is sourced from the incoming request parameters
+    # author details are sourced from the session, to be populated by rack middleware ahead of us
    def commit_message
      commit_message = { :message => params[:message] }
      author_parameters = session['gollum.author']