elvarg 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3118f2f2f8a4592ebe5e1bbd48e54165fc4119344dd395fb05f4418f924a685f
-  data.tar.gz: 3b24d648e84bf24139b8667ea5f024b2f2079f355ae6763ad3e131b801a024d9
+  metadata.gz: 920aa0f27b24660146ba4847ce33976ce2d03ac6dd153791a98c78964053f471
+  data.tar.gz: 2c3c1a4ab8ff241ced853da44e3daffe1541a1caa46e3fed19d68f6d3d53dc88
 SHA512:
-  metadata.gz: 38cb35cd448c88b6adef48f938abb9668cc3aa383cef6cc3b6eb508003edb02b84ef024ddd862d48f9456b1ad740acb9a8e02accc462975b7a136b6a4c004042
-  data.tar.gz: d3f00779a83fe02ab7f428bc50af1a4a7806bbc14a183eb2b9bb979d3c71a99eca54b37c7fb1afac0afc4d27f0669749bb4c531e513c779a56ca8ff9eb28ebc7
+  metadata.gz: ab9bf0cdb8cdc83f1dbd3b4df0d0be24735b00f67d557eb5d22eb40afadd58c2c0a68316aff804b12b77aefb3a884e395fdbcd4532642e97b69dd3818437c3e7
+  data.tar.gz: 12309a4c49b83f480eabf428fd8a6d61eb9eb33bfc688ee1d4043b32d2330e30ba4851c69bc1ee0da0cc45d666b222c0d7c728dc4f0b0bf5f78f8a78972819a6

data/lib/hiscores/player.rb

@@ -8,13 +8,26 @@ module Elvarg #:nodoc:
     # Represents a Player on the Hiscores
     class Player
       include Elvarg::Stats
-      # The Player's username
+      # [String] The Player's username
+      #
+      # @example A player named "ruby"
+      #   player = Elvarg::Hiscores::Player.new 'ruby'
+      #   player.username #=> "ruby"
       attr_reader :username
-      # The Hiscore's mode.
+      # [Symbol] The Hiscore's mode.
       # This can be :default, :ironman, :ultimate, etc.
+      #
       # @see Hiscores::MODES for complete list
       attr_reader :mode
-      # A Hash of all Stats available in OldSchool Runescape's Hiscores
+      # [Hash] All Stats available in OldSchool Runescape's Hiscores
+      #
+      # @example Information on a Player's overall skill
+      #   player = Elvarg::Hiscores::Player.new 'example'
+      #   player.skills #=> { ... } a Hash will all the skills' data
+      #   player.skills[:overall] #=> Overall skill
+      #
+      # @see Elvarg::Stats::SKILLS Complete list of skills
+      # @see Elvarg::Hiscores::Skill
       attr_reader :skills
 
       ##

data/lib/hiscores/skill.rb

@@ -5,11 +5,11 @@ module Elvarg #:nodoc:
     ##
     # Represents a Skill on the Hiscores
     class Skill < Stats::Skill
-      # The rank of the Skill the Player has on the Hiscores
+      # [Integer] The rank of the Skill the Player has on the Hiscores
       attr_reader :rank
-      # The level of the Skill the Player has on the Hiscores
+      # [Integer] The level of the Skill the Player has on the Hiscores
       attr_reader :level
-      # The experience of the Skill the Player has on the Hiscores
+      # [Integer] The experience of the Skill the Player has on the Hiscores
       attr_reader :exp
 
       ##

data/lib/stats/skill.rb

@@ -5,14 +5,14 @@ module Elvarg #:nodoc:
     ##
     # Represents a Skill in OldSchool RuneScape
     class Skill
-      # The link to the `.gif` of the related Skill
+      # [String] The link to the `.gif` of the related Skill
       attr_reader :icon
-      # The unique id of this Skill
+      # [Integer] The unique id of this Skill
       attr_reader :id
-      # The human readable name of this Skill
+      # [String] The human readable name of this Skill
       attr_reader :name
       ##
-      # The symbol of this Skill
+      # [Symbol] The symbol of this Skill
       # @see Elvarg::Stats::SKILLS for list of symbols
       attr_reader :symbol
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elvarg
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Marcello A. Sabino