Make updates resulting from doc review (#38)

Updates resulting from doc review Add documentation link the in the gemspec Make minor documentation changes for clarity
main-branch · Jan 3, 2024 · 97dbcf5 · 97dbcf5
1 parent 93eab18
commit 97dbcf5
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 5 deletions.
diff --git a/lib/process_executer.rb b/lib/process_executer.rb
@@ -12,7 +12,8 @@
 module ProcessExecuter
   # Execute the specified command as a subprocess and return the exit status
   #
-  # This method blocks until the command has terminated.
+  # This is a convenience method that calls Process.spawn and blocks until the
+  # command has terminated.
   #
   # The command will be send the SIGKILL signal if it does not terminate within
   # the specified timeout.
@@ -38,7 +39,7 @@ module ProcessExecuter
   #   documentation for valid command and options
   #
   # @see ProcessExecuter::Options#initialize See ProcessExecuter::Options#initialize
-  #   for additional options that may be specified
+  #   for options that may be specified
   #
   # @param command [Array<String>] the command to execute
   # @param options_hash [Hash] the options to use when exectuting the command

diff --git a/lib/process_executer/options.rb b/lib/process_executer/options.rb
@@ -27,13 +27,14 @@ class Options
       close_others chdir
     ].freeze
 
-    # These options are allowed but should NOT be passed to `Process.spawn`
+    # These options are allowed by `ProcessExecuter.spawn` but should NOT be passed
+    # to `Process.spawn`
     #
     NON_SPAWN_OPTIONS = %i[
       timeout
     ].freeze
 
-    # Any `SPAWN_OPTIONS`` set to this value will not be passed to `Process.spawn`
+    # Any `SPAWN_OPTIONS` set to `NOT_SET` will not be passed to `Process.spawn`
     #
     NOT_SET = :not_set
 
@@ -76,7 +77,7 @@ class Options
     # @param options [Hash] Process.spawn options plus additional options listed below.
     #
     #   See [Process.spawn](https://ruby-doc.org/core/Process.html#method-c-spawn)
-    #   for a list of valid.
+    #   for a list of valid options that can be passed to `Process.spawn`.
     #
     # @option options [Integer, Float, nil] :timeout
     #   Number of seconds to wait for the process to terminate. Any number

diff --git a/process_executer.gemspec b/process_executer.gemspec
@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/main-branch/process_executer'
   spec.metadata['changelog_uri'] = 'https://rubydoc.info/gems/process_executer/file/CHANGELOG.md'
+  spec.metadata['documentation_uri'] = "https://rubydoc.info/gems/process_executer/#{ProcessExecuter::VERSION}"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.