Skip to content

Commit 66381f6

Browse files
committed
Add missing documentation.
1 parent 8b535a9 commit 66381f6

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

lib/async/container/forked.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -189,6 +189,7 @@ def inspect
189189
"\#<#{self.class} name=#{@name.inspect} status=#{@status.inspect} pid=#{@pid.inspect}>"
190190
end
191191

192+
# @returns [String] A string representation of the process.
192193
alias to_s inspect
193194

194195
# Invoke {#terminate!} and then {#wait} for the child process to exit.

lib/async/container/notify/log.rb

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,14 @@ class Log < Client
1414
# The name of the environment variable which contains the path to the notification socket.
1515
NOTIFY_LOG = "NOTIFY_LOG"
1616

17+
# @returns [String] The path to the notification log file.
18+
# @parameter environment [Hash] The environment variables, defaults to `ENV`.
1719
def self.path(environment = ENV)
1820
environment[NOTIFY_LOG]
1921
end
2022

2123
# Open a notification client attached to the current {NOTIFY_LOG} if possible.
24+
# @parameter environment [Hash] The environment variables, defaults to `ENV`.
2225
def self.open!(environment = ENV)
2326
if path = self.path(environment)
2427
self.new(path)

0 commit comments

Comments
 (0)