Skip to content

Commit 8f05ef7

Browse files
committed
Corrected the YARD @return tags for Database.update and #update!.
1 parent d6d0ae8 commit 8f05ef7

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

lib/bundler/audit/database.rb

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -141,9 +141,8 @@ def self.download(options={})
141141
# @option options [Boolean] :quiet
142142
# Specify whether `git` should be `--quiet`.
143143
#
144-
# @return [Boolean, nil]
144+
# @return [Boolean]
145145
# Specifies whether the update was successful.
146-
# A `nil` indicates no update was performed.
147146
#
148147
# @raise [ArgumentError]
149148
# Invalid options were given.
@@ -191,10 +190,11 @@ def git?
191190
# @option options [Boolean] :quiet
192191
# Specify whether `git` should be `--quiet`.
193192
#
194-
# @return [true, nil]
195-
# `true` indicates that the update was successful.
196-
# `nil` indicates the database is not a git repository, thus not
197-
# capable of being updated.
193+
# @return [true]
194+
# The ruby-advisory-db git repository was successfully updated.
195+
#
196+
# @raise [UpdateFailed]
197+
# Could not update the ruby-advisory-db git repository.
198198
#
199199
# @since 0.8.0
200200
#

0 commit comments

Comments
 (0)