Skip to content

Commit d1bab4c

Browse files
committed
Doc update
1 parent f84d0ab commit d1bab4c

File tree

4 files changed

+12
-6
lines changed

4 files changed

+12
-6
lines changed

.yardopts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
--protected --no-private --embed-mixins --output-dir ./doc --markup markdown
1+
--protected
2+
--no-private
3+
--embed-mixins
4+
--output-dir ./doc
5+
--markup markdown
6+
-
7+
lib/concurrent/actress/doc.md

lib/concurrent/actress.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
module Concurrent
77

8-
# {include:file:lib/concurrent/actress/doc.md}
8+
# Fore more information please see {file:lib/concurrent/actress/doc.md Actress quide}.
99
module Actress
1010

1111
require 'concurrent/actress/type_check'

lib/concurrent/actress/context.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,12 +72,12 @@ def self.included(base)
7272
end
7373

7474
module ClassMethods
75-
# behaves as {Actress.spawn} but class_name is omitted
75+
# behaves as {Concurrent::Actress.spawn} but class_name is omitted
7676
def spawn(name_or_opts, *args, &block)
7777
Actress.spawn spawn_optionify(name_or_opts, *args), &block
7878
end
7979

80-
# behaves as {Actress.spawn!} but class_name is omitted
80+
# behaves as {Concurrent::Actress.spawn!} but class_name is omitted
8181
def spawn!(name_or_opts, *args, &block)
8282
Actress.spawn! spawn_optionify(name_or_opts, *args), &block
8383
end

lib/concurrent/actress/doc.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Light-weighted implement of Actors. Inspired by Akka and Erlang.
1+
# Light-weighted implementation of Actors. Inspired by Akka and Erlang.
22

3-
Actors are using a thread-pool by default which makes them very cheap to create and discard.
3+
Actors are sharing a thread-pool by default which makes them very cheap to create and discard.
44
Thousands of actors can be created allowing to brake the program to small maintainable pieces
55
without breaking single responsibility principles.
66

0 commit comments

Comments
 (0)