aboutsummaryrefslogtreecommitdiffstats
path: root/signal.c
diff options
context:
space:
mode:
authornobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2016-09-28 04:00:27 +0000
committernobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2016-09-28 04:00:27 +0000
commit9618889fa4bf4919ef148c04fee7514871fab292 (patch)
tree9594c20d027ba69843df1c5a9104ca54ce8787a7 /signal.c
parentaf653bf3f8ea0a7bb61ec58ba50cc31e53c1c1e1 (diff)
downloadruby-9618889fa4bf4919ef148c04fee7514871fab292.tar.gz
Update Signal.signame doc [ci-skip]
* signal.c (sig_signame): [DOC] Add documentation in the case of return nil. [Fix GH-1449] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@56280 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'signal.c')
-rw-r--r--signal.c5
1 files changed, 3 insertions, 2 deletions
diff --git a/signal.c b/signal.c
index 32c7c2a099..8ebb6b9c61 100644
--- a/signal.c
+++ b/signal.c
@@ -238,9 +238,10 @@ signo2signm(int no)
/*
* call-seq:
- * Signal.signame(signo) -> string
+ * Signal.signame(signo) -> string or nil
*
- * convert signal number to signal name
+ * Convert signal number to signal name.
+ * Returns +nil+ if the signo is an invalid signal number.
*
* Signal.trap("INT") { |signo| puts Signal.signame(signo) }
* Process.kill("INT", 0)