Skip to content

Commit

Permalink
Tweak the doc comments for Religion/Bible
Browse files Browse the repository at this point in the history
Follow up of #1656.
  • Loading branch information
koic committed Feb 10, 2022
1 parent cb69fe4 commit cb606b8
Showing 1 changed file with 24 additions and 30 deletions.
54 changes: 24 additions & 30 deletions lib/faker/religion/bible.rb
Original file line number Diff line number Diff line change
Expand Up @@ -7,46 +7,40 @@ class Bible < Base

class << self
##
## Returns a random bible character
##
## @param
##
## @return [String]
##
## @example
## Faker::Religion::Bible.character #=> "Jesus"
##
## @faker.version next
# Returns a random bible character.
#
# @return [String]
#
# @example
# Faker::Religion::Bible.character #=> "Jesus"
#
# @faker.version next
def character
fetch('bible.character')
end

##
## Returns a random location(city or town) from the bible
##
## @param
##
## @return [String]
##
## @example
## Faker::Religion::Bible.location #=> "Nasareth"
##
## @faker.version next
# Returns a random location(city or town) from the bible
#
# @return [String]
#
# @example
# Faker::Religion::Bible.location #=> "Nasareth"
#
# @faker.version next
def location
fetch('bible.location')
end

##
## Returns a random quote from the location
##
## @param
##
## @return [String]
##
## @example
## Faker::Religion::Bible.quote #=> "Seek first the kingdom of God "
##
## @faker.version next
# Returns a random quote from the location.
#
# @return [String]
#
# @example
# Faker::Religion::Bible.quote #=> "Seek first the kingdom of God "
#
# @faker.version next
def quote
fetch('bible.quote')
end
Expand Down

0 comments on commit cb606b8

Please sign in to comment.