From ca6e689e6216a8e9d0c011747cf5c36ec476a04d Mon Sep 17 00:00:00 2001 From: Daniel Tiringer <53534182+danielTiringer@users.noreply.github.com> Date: Sat, 20 Jun 2020 06:51:19 +0200 Subject: [PATCH] Add missing documentation to Faker::Computer (#2065) * Update computer version after publishing * Add documentation page to Faker::Computer * Correct the version number --- doc/default/computer.md | 17 +++++++++++++++++ lib/faker/default/computer.rb | 8 ++++---- 2 files changed, 21 insertions(+), 4 deletions(-) create mode 100644 doc/default/computer.md diff --git a/doc/default/computer.md b/doc/default/computer.md new file mode 100644 index 0000000000..7694193b0c --- /dev/null +++ b/doc/default/computer.md @@ -0,0 +1,17 @@ +# Faker::Computer + +Available since version 2.12.0. + +```ruby +# A random computer platform +Faker::Computer.platform #=> "Linux" + +# A random computer type +Faker::Computer.type #=> "server" + +# A random computer OS +Faker::Computer.os #=> "RHEL 6.10" + +# A random computer platform and OS combination. +Faker::Computer.stack #=> "Linux, RHEL 6.10" +``` diff --git a/lib/faker/default/computer.rb b/lib/faker/default/computer.rb index 7bc665f5f2..20a61232d8 100644 --- a/lib/faker/default/computer.rb +++ b/lib/faker/default/computer.rb @@ -11,7 +11,7 @@ class << self # @example # Faker::Computer.platform #=> "Linux" # - # @faker.version next + # @faker.version 2.12.0 def platform fetch('computer.platform') end @@ -24,7 +24,7 @@ def platform # @example # Faker::Computer.type #=> "server" # - # @faker.version next + # @faker.version 2.12.0 def type fetch('computer.type') end @@ -38,7 +38,7 @@ def type # @example # Faker::Computer.os #=> "RHEL 6.10" # - # @faker.version next + # @faker.version 2.12.0 def os(platform: self.platform) platform = self.platform unless fetch_all('computer.platform').include?(platform) fetch("computer.os.#{platform.downcase}") @@ -52,7 +52,7 @@ def os(platform: self.platform) # @example # Faker::Computer.stack #=> "Linux, RHEL 6.10" # - # @faker.version next + # @faker.version 2.12.0 def stack platform = self.platform os = fetch("computer.os.#{platform.downcase}")