Skip to content

Commit

Permalink
Add YARD docs for Faker::Restaurant. (#1768)
Browse files Browse the repository at this point in the history
This also makes the restaurant class methods explicit so they
can be documented.
  • Loading branch information
connorshea authored and vbrazo committed Sep 29, 2019
1 parent 71fe3a6 commit a7cdf12
Showing 1 changed file with 54 additions and 2 deletions.
56 changes: 54 additions & 2 deletions lib/faker/default/restaurant.rb
Expand Up @@ -4,8 +4,60 @@ module Faker
class Restaurant < Base
flexible :restaurant

def self.name
bothify(parse('restaurant.name'))
class << self
##
# Produces the name of a restaurant.
#
# @return [String]
#
# @example
# Faker::Restaurant.name #=> "Curry King"
#
# @faker.version 1.9.2
def name
bothify(parse('restaurant.name'))
end

##
# Produces a type of restaurant.
#
# @return [String]
#
# @example
# Faker::Restaurant.type #=> "Comfort Food"
#
# @faker.version 1.9.2
def type
fetch('restaurant.type')
end

##
# Produces a description of a restaurant.
#
# @return [String]
#
# @example
# Faker::Restaurant.description
# #=> "We are committed to using the finest ingredients in our recipes. No food leaves our kitchen that we ourselves would not eat."
#
# @faker.version 1.9.2
def description
fetch('restaurant.description')
end

##
# Produces a review for a restaurant.
#
# @return [String]
#
# @example
# Faker::Restaurant.review
# #=> "Brand new. Great design. Odd to hear pop music in a Mexican establishment. Music is a bit loud. It should be background."
#
# @faker.version 1.9.2
def review
fetch('restaurant.review')
end
end
end
end

0 comments on commit a7cdf12

Please sign in to comment.