Skip to content

Commit

Permalink
Fix yard documentation issues (#2016)
Browse files Browse the repository at this point in the history
* Update parameter extension to proper ext

* The correct parameter name is number

* Reformat example to match yard specs

* Correct parameters used for method

* Make uk_driving_licence method parameters conditional

* Card type should be types
  • Loading branch information
danielTiringer committed May 25, 2020
1 parent 2ad1e42 commit f957308
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 10 deletions.
2 changes: 1 addition & 1 deletion lib/faker/default/address.rb
Expand Up @@ -102,7 +102,7 @@ def community
# @return [String]
#
# @example
# Faker::Address.mail_box #=> "PO Box 123"
# Faker::Address.mail_box #=> "PO Box 123"
#
# @faker.version 2.9.1
def mail_box
Expand Down
10 changes: 6 additions & 4 deletions lib/faker/default/driving_licence.rb
Expand Up @@ -57,10 +57,12 @@ def northern_irish_driving_licence
##
# Produces a random UK driving licence number in either GB or NI format, at a rate consistent with their relative populations
#
# @param last_name [String] The last name of the driving licence's owner.
# @param initials [String] The initials of the driving licence's owner.
# @param gender [String] The gender of the driving licence's owner.
# @param date_of_birth [String] The date of birth of the driving licence's owner.
# @overload uk_driving_licence(last_name, initials, gender, date_of_birth)
# @param last_name [String] The last name of the driving licence's owner.
# @param initials [String] The initials of the driving licence's owner.
# @param gender [String] The gender of the driving licence's owner.
# @param date_of_birth [String] The date of birth of the driving licence's owner.
# @overload uk_driving_licence()
# @return [String]
#
# @example
Expand Down
2 changes: 1 addition & 1 deletion lib/faker/default/file.rb
Expand Up @@ -66,7 +66,7 @@ def mime_type
#
# @param dir [String] Specifies the path used for the generated file.
# @param name [String] Specifies the filename used for the generated file.
# @param extension [String] Specifies the extension used the generated file.
# @param ext [String] Specifies the extension used the generated file.
# @param directory_separator [String] Specifies the separator between the directory and name elements.
# @return [String]
#
Expand Down
2 changes: 1 addition & 1 deletion lib/faker/default/finance.rb
Expand Up @@ -10,7 +10,7 @@ class << self
##
# Produces a random credit card number.
#
# @param card_type [String] Specific credit card type.
# @param types [String] Specific credit card type.
# @return [String]
#
# @example
Expand Down
2 changes: 1 addition & 1 deletion lib/faker/default/name.rb
Expand Up @@ -121,7 +121,7 @@ def suffix
##
# Produces random initials.
#
# @param digits [Integer] Number of digits that the generated initials should have.
# @param number [Integer] Number of digits that the generated initials should have.
# @return [String]
#
# @example
Expand Down
4 changes: 2 additions & 2 deletions lib/faker/default/twitter.rb
Expand Up @@ -75,8 +75,8 @@ def user(legacy_include_status = NOT_GIVEN, legacy_include_email = NOT_GIVEN, in
##
# Produces a random Twitter user.
#
# @param include_status [Boolean] Include or exclude user status details
# @param include_email [Boolean] Include or exclude user email details
# @param include_user [Boolean] Include or exclude user details
# @param include_photo [Boolean] Include or exclude user photo
# @return [Hash]
#
# @example
Expand Down

0 comments on commit f957308

Please sign in to comment.