diff options
author | zverok <zverok.offline@gmail.com> | 2019-10-24 19:35:36 +0300 |
---|---|---|
committer | Nobuyoshi Nakada <nobu@ruby-lang.org> | 2019-10-26 14:58:08 +0900 |
commit | bddb31bb37f878cf171f89ac54f7e43d7d59c444 (patch) | |
tree | a332274fe4ac60ae0f8a60331769cf78ca3d8805 /process.c | |
parent | cf9344131c3d0f5993c6d999c427a4c656df30a2 (diff) | |
download | ruby-bddb31bb37f878cf171f89ac54f7e43d7d59c444.tar.gz |
Documentation improvements for Ruby core
* Top-level `return`;
* Documentation for comments syntax;
* `rescue` inside blocks;
* Enhance `Object#to_enum` docs;
* Make `chomp:` option more obvious for `String#each_line` and
`#lines`;
* Enhance `Proc#>>` and `#<<` docs;
* Enhance `Processs` class docs.
Diffstat (limited to 'process.c')
-rw-r--r-- | process.c | 16 |
1 files changed, 14 insertions, 2 deletions
@@ -416,7 +416,19 @@ parent_redirect_close(int fd) /* * Document-module: Process * - * Module to handle processes. + * The module contains several groups of functionality for handling OS processes: + * + * * Low-level property introspection and management of current process, like + * Process.argv0, Process.pid; + * * Low-level introspection of other processes, like Process.getpgid, Process.getpriority; + * * Management of the current process: Process.abort, Process.exit, Process.daemon etc. + * (for convenience, most of those are also available as a global functions, + * and module functions of Kernel); + * * Creation and management of child processes: Process.fork, Process.spawn and + * related methods; + * * Management of low-level system clock: Process.times and Process.clock_gettime, + * which could be important for proper benchmarking and other elapsed + * time measurement tasks. */ static VALUE @@ -5127,7 +5139,7 @@ proc_getpriority(VALUE obj, VALUE which, VALUE who) * call-seq: * Process.setpriority(kind, integer, priority) -> 0 * - * See Process#getpriority. + * See Process.getpriority. * * Process.setpriority(Process::PRIO_USER, 0, 19) #=> 0 * Process.setpriority(Process::PRIO_PROCESS, 0, 19) #=> 0 |