[MacRuby-devel] need review for macrubyc man-page

[Rich Morin]

General

  Overly long sentences are harder to comprehend, construct, and
  punctuate correctly.  In general, a warning light should go on
  after 10 words in a sentence.  The light should turn red at 15
  or 20 words.  The sentence below (35 words!) should set off air
  raid sirens...

    A MacRuby loadable object is a Mach-O bundle compiled with
    a global constructor that will evaluate the Ruby machine
    code once it's loaded by the dynamic linker, at runtime,
    generally upon a Ruby #require statement.

  The "serial", or "Oxford" comma reduces ambiguity:

    I'd like to thank my parents,
    God and Mother Teresa.

  Adding a blank line between expository text and examples makes
  both of them easier to read.


Specific

... objects, dynamic libraries  or executables.
                     libraries,

... advantages;  the ...
    advantages.  The

... of the program, and the original ...
... of the program.     The original ...

... available as is since it has ...
... available, as it has ...

Compile, assemble  and link a ...
         assemble,

... by rubyc are dynamically linking against ...
                             linked


... that are statically linking against ...
                        linked

... the MacRuby runtime, for example  executables ... rubyc.
... the MacRuby runtime (for example, executables ... rubyc).

... bundles are using the .rbo file extension and can simply be ...
... bundles use the .rbo file extension and can be ...

The source files can later be removed.
The source files can be removed later.

rubyc without any option will ...
When used without any options, rubyc will ...

... main file and its machine code will be ran once ...
... main file. Its machine code will be run once ...

...  executable but only ran upon #require calls.
...  executable, but only run upon #require calls.

... will ran upon #require calls.
         run

 ruby(1) irb(1) ruby_deploy(1)
 ruby(1), irb(1), ruby_deploy(1)
-- 
http://www.cfcl.com/rdm            Rich Morin
http://www.cfcl.com/rdm/resume     rdm at cfcl.com
http://www.cfcl.com/rdm/weblog     +1 650-873-7841

Technical editing and writing, programming, and web development