From a9334475d206ab3e1e53af51426fa39fe67021de Mon Sep 17 00:00:00 2001 From: danielTiringer Date: Fri, 12 Jun 2020 20:40:11 +0200 Subject: [PATCH] Add YARD docs to Faker::NHS --- lib/faker/default/nhs.rb | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/lib/faker/default/nhs.rb b/lib/faker/default/nhs.rb index 7d8c0af1aa..70bf8dd142 100644 --- a/lib/faker/default/nhs.rb +++ b/lib/faker/default/nhs.rb @@ -3,6 +3,15 @@ module Faker class NationalHealthService < Base class << self + ## + # Produces a random British NHS number. + # + # @return [String] + # + # @example + # Faker::NationalHealthService.british_number #=> "403 958 5577" + # + # @faker.version 1.9.2 def british_number base_number = rand(400_000_001...499_999_999) # If the check digit is equivalent to 10, the number is invalid. @@ -15,6 +24,16 @@ def british_number .join('') end + ## + # Produces a random British NHS number's check digit. + # + # @param number [Integer] Specifies the NHS number the check digit belongs to. + # @return [Integer] + # + # @example + # Faker::NationalHealthService.check_digit(number: 400_012_114) #=> 6 + # + # @faker.version 1.9.2 def check_digit(legacy_number = NOT_GIVEN, number: 0) warn_for_deprecated_arguments do |keywords| keywords << :number if legacy_number != NOT_GIVEN