elvarg 0.0.7 → 0.0.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 920aa0f27b24660146ba4847ce33976ce2d03ac6dd153791a98c78964053f471
4
- data.tar.gz: 2c3c1a4ab8ff241ced853da44e3daffe1541a1caa46e3fed19d68f6d3d53dc88
3
+ metadata.gz: 783380f7cf39ce52fbad8a0b0a2f368be777c18b81f15ae1be7c060e59e165fd
4
+ data.tar.gz: fba3218c73c78b217915b756ad4dad0c5d1f72a48ff82a6ad6ac0b29b5b560c8
5
5
  SHA512:
6
- metadata.gz: ab9bf0cdb8cdc83f1dbd3b4df0d0be24735b00f67d557eb5d22eb40afadd58c2c0a68316aff804b12b77aefb3a884e395fdbcd4532642e97b69dd3818437c3e7
7
- data.tar.gz: 12309a4c49b83f480eabf428fd8a6d61eb9eb33bfc688ee1d4043b32d2330e30ba4851c69bc1ee0da0cc45d666b222c0d7c728dc4f0b0bf5f78f8a78972819a6
6
+ metadata.gz: 0e1e12705917008b83af3f84783f1501f096d57b3e69679d372ebd611e5a9f79de5fde22d7dc549011ce43dee02e4726214dd3ea5e23f92d7754bd3a36ca933a
7
+ data.tar.gz: 2c2d07c8b288cc14d60a769ea4977761e657a23c2841a565c1601c10d1474e92b70479b92748038a8e13e8c645386ebeb3e6c054c89cf2c0a81e8c809474300c
@@ -8,18 +8,21 @@ module Elvarg #:nodoc:
8
8
  # Represents a Player on the Hiscores
9
9
  class Player
10
10
  include Elvarg::Stats
11
- # [String] The Player's username
11
+ # The Player's username
12
12
  #
13
13
  # @example A player named "ruby"
14
14
  # player = Elvarg::Hiscores::Player.new 'ruby'
15
15
  # player.username #=> "ruby"
16
+ #
17
+ # @return [String] The Player's username
16
18
  attr_reader :username
17
- # [Symbol] The Hiscore's mode.
19
+ # The Hiscore's mode.
18
20
  # This can be :default, :ironman, :ultimate, etc.
19
21
  #
20
22
  # @see Hiscores::MODES for complete list
23
+ # @return [Symbol] The Hiscore's mode.
21
24
  attr_reader :mode
22
- # [Hash] All Stats available in OldSchool Runescape's Hiscores
25
+ # All Stats available in OldSchool Runescape's Hiscores
23
26
  #
24
27
  # @example Information on a Player's overall skill
25
28
  # player = Elvarg::Hiscores::Player.new 'example'
@@ -28,6 +31,7 @@ module Elvarg #:nodoc:
28
31
  #
29
32
  # @see Elvarg::Stats::SKILLS Complete list of skills
30
33
  # @see Elvarg::Hiscores::Skill
34
+ # @return [Hash] All Stats available in OldSchool Runescape's Hiscores
31
35
  attr_reader :skills
32
36
 
33
37
  ##
@@ -5,11 +5,11 @@ module Elvarg #:nodoc:
5
5
  ##
6
6
  # Represents a Skill on the Hiscores
7
7
  class Skill < Stats::Skill
8
- # [Integer] The rank of the Skill the Player has on the Hiscores
8
+ # @return [Integer] The rank of the Skill the Player has on the Hiscores
9
9
  attr_reader :rank
10
- # [Integer] The level of the Skill the Player has on the Hiscores
10
+ # @return [Integer] The level of the Skill the Player has on the Hiscores
11
11
  attr_reader :level
12
- # [Integer] The experience of the Skill the Player has on the Hiscores
12
+ # @return [Integer] The experience of the Skill the Player has on the Hiscores
13
13
  attr_reader :exp
14
14
 
15
15
  ##
@@ -5,14 +5,14 @@ module Elvarg #:nodoc:
5
5
  ##
6
6
  # Represents a Skill in OldSchool RuneScape
7
7
  class Skill
8
- # [String] The link to the `.gif` of the related Skill
8
+ # @return [String] The link to the `.gif` of the related Skill
9
9
  attr_reader :icon
10
- # [Integer] The unique id of this Skill
10
+ # @return [Integer] The unique id of this Skill
11
11
  attr_reader :id
12
- # [String] The human readable name of this Skill
12
+ # @return [String] The human readable name of this Skill
13
13
  attr_reader :name
14
14
  ##
15
- # [Symbol] The symbol of this Skill
15
+ # @return [Symbol] The symbol of this Skill
16
16
  # @see Elvarg::Stats::SKILLS for list of symbols
17
17
  attr_reader :symbol
18
18
 
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: elvarg
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.7
4
+ version: 0.0.8
5
5
  platform: ruby
6
6
  authors:
7
7
  - Marcello A. Sabino