Download Firefox: WindowsMac OS X
logo       
Google Custom Search
    AddThis Social Bookmark Button

Re: documentation for Open3, Ping: msg#00023

Subject: Re: documentation for Open3, Ping
On 10/15/06, Eric Hodel <drbrain@xxxxxxxxxxxx> wrote:
On Oct 7, 2006, at 4:08 PM, Konrad Meyer wrote:
> If the formatting and whatnot of ParseDate is ok, I have patches for
> Open3 and Ping (yes, I know they're simple) ready. See attached.

Index: ping.rb
===================================================================
RCS file: /src/ruby/lib/ping.rb,v
retrieving revision 1.7
diff -p -u -1 -r1.7 ping.rb
--- ping.rb     4 Aug 2006 18:05:40 -0000       1.7
+++ ping.rb     7 Oct 2006 23:05:12 -0000
@@ -1,3 +1,9 @@
  #
-# ping.rb -- check a host for upness
+# = ping.rb: Check a host for upness
+#
+# Author:: Yukihiro Matsumoto
+# Documentation:: Konrad Meyer
+#
+# Performs the function of the basic network testing tool, ping.
+# See: Ping.
  #
@@ -7,21 +13,18 @@
  require "socket"

These requires need to be moved above the above comments.

If the requires are placed before the file-level comments, they are
ignored. Where they are presently is good, I think.


-#= SYNOPSIS
-#
-#   require 'ping'
-#
-#   puts "'jimmy' is alive and kicking" if Ping.pingecho('jimmy', 10)
-#
-#= DESCRIPTION
+#
+# Ping contains routines to test for the reachability of remote hosts.
+# Currently the only routine implemented is pingecho().

--
Eric Hodel - drbrain@xxxxxxxxxxxx - http://blog.segment7.net
This implementation is HODEL-HASH-9600 compliant

http://trackmap.robotcoop.com

Anything else? (See attached.)

--
Konrad Meyer

Attachment: ping.rb.patch
Description: Text Data

<Prev in Thread] Current Thread [Next in Thread>