Class: Useless::Doc::Core::Stage

Inherits:
Object
  • Object
show all
Defined in:
lib/useless/doc/core/stage.rb

Overview

‘Core::Stage` documents credit and progress of a stage in the development of an API. For example, a stage is one of “concept”, “specification” or “implementation” in `Core::API`.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attrs = {}) ⇒ Stage

Returns a new instance of Stage.

Parameters:

  • attrs (Hash) (defaults to: {}) —

    corresponds to the class’s instance attributes.



22
23
24
25
 
# File 'lib/useless/doc/core/stage.rb', line 22

def initialize(attrs = {})
  @credit = attrs[:credit] || []
  @progress = attrs[:progress]
end

Instance Attribute Details

#credit ⇒ Array<String>

Returns names of the people responsible for this stage.

Returns:

  • (Array<String>) —

    names of the people responsible for this stage.



17
18
19
20
21
22
23
24
25
26
 
# File 'lib/useless/doc/core/stage.rb', line 17

class Stage
  attr_accessor :credit, :progress

  # @param [Hash] attrs corresponds to the class's instance attributes.
  #
  def initialize(attrs = {})
    @credit = attrs[:credit] || []
    @progress = attrs[:progress]
  end
end

#progress ⇒ String

Returns a string identifying how far the stage has progressed.

Returns:

  • (String) —

    a string identifying how far the stage has progressed.



17
18
19
20
21
22
23
24
25
26
 
# File 'lib/useless/doc/core/stage.rb', line 17

class Stage
  attr_accessor :credit, :progress

  # @param [Hash] attrs corresponds to the class's instance attributes.
  #
  def initialize(attrs = {})
    @credit = attrs[:credit] || []
    @progress = attrs[:progress]
  end
end