Skip to content

Commit 186ee2c

Browse files
committed
Add yard doc for changes in #commit
Signed-off-by: Agora Security <github@agora-security.com>
1 parent 6c0509a commit 186ee2c

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

lib/git/lib.rb

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -550,6 +550,18 @@ def remove(path = '.', opts = {})
550550
command('rm', arr_opts)
551551
end
552552

553+
# Takes the commit message with the options and executes the commit command
554+
#
555+
# accepts options:
556+
# :amend
557+
# :all
558+
# :allow_empty
559+
# :author
560+
# :date
561+
# :no_verify
562+
#
563+
# @param [String] message the commit message to be used
564+
# @param [Array] opts the commit options to be used
553565
def commit(message, opts = {})
554566
arr_opts = []
555567
arr_opts << "--message=#{message}" if message

0 commit comments

Comments
 (0)