Skip to content

Instantly share code, notes, and snippets.

@matthewd
Created December 16, 2010 01:58
Show Gist options
  • Save matthewd/742906 to your computer and use it in GitHub Desktop.
Save matthewd/742906 to your computer and use it in GitHub Desktop.
From 647cf59d17b7a3456346799acbf4fed9bfa4b9ed Mon Sep 17 00:00:00 2001
From: Matthew Draper <matthew@trebex.net>
Date: Thu, 16 Dec 2010 12:27:24 +1030
Subject: [PATCH] Quick copy-edit of the English docs.
---
web/_site/doc/en/appendix-a-glossary/index.html | 7 ++++---
.../doc/en/appendix-b-reading-list/index.html | 4 ++--
web/_site/doc/en/bootstrapping/index.html | 12 ++++++------
web/_site/doc/en/build-system/index.html | 2 +-
web/_site/doc/en/contributing/index.html | 2 +-
.../doc/en/getting-started/building/index.html | 2 +-
.../en/getting-started/troubleshooting/index.html | 6 +++---
.../doc/en/how-to/write-a-ruby-spec/index.html | 2 +-
.../doc/en/how-to/write-documentation/index.html | 3 ++-
web/_site/doc/en/ruby/global-variables/index.html | 4 ++--
web/_site/doc/en/tools/debugger/index.html | 4 ++--
web/_site/releases/index.html | 2 +-
web/doc/en/appendix-a-glossary.markdown | 7 ++++---
web/doc/en/appendix-b-reading-list.markdown | 4 ++--
web/doc/en/bootstrapping.markdown | 12 ++++++------
web/doc/en/build-system.markdown | 2 +-
web/doc/en/contributing.markdown | 2 +-
web/doc/en/getting-started/building.markdown | 2 +-
.../en/getting-started/troubleshooting.markdown | 6 +++---
web/doc/en/how-to/write-a-ruby-spec.markdown | 2 +-
web/doc/en/how-to/write-documentation.markdown | 3 ++-
web/doc/en/ruby/global-variables.markdown | 4 ++--
web/doc/en/tools/debugger.markdown | 4 ++--
web/releases.markdown | 2 +-
24 files changed, 52 insertions(+), 48 deletions(-)
diff --git a/web/_site/doc/en/appendix-a-glossary/index.html b/web/_site/doc/en/appendix-a-glossary/index.html
index a4d7e3f..90533eb 100644
--- a/web/_site/doc/en/appendix-a-glossary/index.html
+++ b/web/_site/doc/en/appendix-a-glossary/index.html
@@ -117,7 +117,7 @@ Guide&rdquo; 2nd or 3rd Edition by Thomas et al [The Pragmatic Programmers
<p><em>metaclass</em></p>
<p>Also called the +singleton+ class or +eigenclass+. Every object in Ruby can
-have one, although, they are only created as necessary. The metaclass holds the
+have one, although they are only created as necessary. The metaclass holds the
method and constant tables that belong only to a particular object instance.
For example, the method +hello+ defined below exists only in the metaclass for
+obj+.</p>
@@ -148,12 +148,13 @@ as the &lsquo;Meta-Object Protocol&rsquo; or +MOP+.</p>
<p><em>method lookup or method resolution</em></p>
<p>The rule is simple: Take the object located in the class slot of the object
-(which is not always the return value of Object#class) and begin searching.</p>
+(which is not always the return value of Object#class; if the object has one,
+it&rsquo;ll be the metaclass) and begin searching.</p>
<p>Searching goes up the superclass chain until the superclass is nil.</p>
<p>In which case, redo lookup for method_missing. If we fail to find
-method_missing, fail tragicly.</p>
+method_missing, fail tragically.</p>
<pre><code> +-------------+
| nil |
diff --git a/web/_site/doc/en/appendix-b-reading-list/index.html b/web/_site/doc/en/appendix-b-reading-list/index.html
index c992987..514d745 100644
--- a/web/_site/doc/en/appendix-b-reading-list/index.html
+++ b/web/_site/doc/en/appendix-b-reading-list/index.html
@@ -108,8 +108,8 @@
<p>Building virtual machines in general and programming language implementations
in particular requires some knowledge. Rubinius&rsquo; goal is to lower the barrier
-by keeping as much as possible in Ruby but to hack on garbage collector you
-have to understand what&rsquo; going on behind the curtains.</p>
+by keeping as much as possible in Ruby but to hack on the garbage collector you
+have to understand what&rsquo;s going on behind the curtains.</p>
<p>This page contains references to books, online lectures, blog posts and any
other publications you may find useful for working on Rubinius.</p>
diff --git a/web/_site/doc/en/bootstrapping/index.html b/web/_site/doc/en/bootstrapping/index.html
index 7a0b6a6..28f9b71 100644
--- a/web/_site/doc/en/bootstrapping/index.html
+++ b/web/_site/doc/en/bootstrapping/index.html
@@ -162,7 +162,7 @@ provided in common are added.</p>
<li>
<p>loader: The compiled version of kernel/loader.rb is run.</p>
- <p>The final stage setups the life cycle of a ruby process. It starts by
+ <p>The final stage sets up the life cycle of a ruby process. It starts by
connecting the VM to the system, sets up load paths, and reads
customization scripts from the home directory. It traps signals, and
processes command line arguments.</p>
@@ -188,11 +188,11 @@ bodies is executed. For instance, when loading</p>
end
</code></pre>
-<p>the call to #attr_accessor will be run. This requires that any code called
-in script, class, or module bodies must be loaded before the file that calls
-the code is loaded. The kernel/alpha.rb defines most of the code that will be
-needed at the script or module level. However, other load order dependencies
-exist between some of the platform, common, delta, and compiler files.</p>
+<p>the call to #attr_accessor will be run. This requires that any code called in
+script, class, or module bodies be loaded before the file that calls the code.
+The kernel/alpha.rb defines most of the code that will be needed at the script
+or module level. However, other load order dependencies exist between some of
+the platform, common, delta, and compiler files.</p>
<p>These load order dependencies are addressed by the load_order.txt file located
in each of the kernel/** directories. If you modify code that adds a load
diff --git a/web/_site/doc/en/build-system/index.html b/web/_site/doc/en/build-system/index.html
index b56382c..0c7b5c1 100644
--- a/web/_site/doc/en/build-system/index.html
+++ b/web/_site/doc/en/build-system/index.html
@@ -114,7 +114,7 @@ typically use makefiles.</p>
<h2 id="development-versus-install-builds">Development versus Install Builds</h2>
-<p>Rubinius is comprised of the executable and various support files like the core
+<p>Rubinius consists of the executable, and various support files like the core
and standard libraries. The executable needs to know where to find these files
even if moved to a different location. To handle this problem, Rubinius
distinguishes two build types: development and install. The executable stores
diff --git a/web/_site/doc/en/contributing/index.html b/web/_site/doc/en/contributing/index.html
index 6e75117..6c9126d 100644
--- a/web/_site/doc/en/contributing/index.html
+++ b/web/_site/doc/en/contributing/index.html
@@ -109,7 +109,7 @@ with us in the #rubinius IRC channel on irc.freenode.net.</p>
<h2 id="run-your-code">Run Your Code</h2>
<p>Your code is often more vicious than the specs. Run your pet project under
-rubinius and report issues. See <a href="/doc/en/how-to/write-a-ticket">How To Write a Ticket</a>.</p>
+Rubinius and report issues. See <a href="/doc/en/how-to/write-a-ticket">How To Write a Ticket</a>.</p>
<h2 id="ask-for-help">Ask For Help</h2>
diff --git a/web/_site/doc/en/getting-started/building/index.html b/web/_site/doc/en/getting-started/building/index.html
index aaffed1..c85ca51 100644
--- a/web/_site/doc/en/getting-started/building/index.html
+++ b/web/_site/doc/en/getting-started/building/index.html
@@ -107,7 +107,7 @@ version of LLVM. If you have installed LLVM on your system, pass the
<h3 id="getting-the-source">Getting the Source</h3>
-<p>The Rubinius source code available as a tarball and as a project on Github.
+<p>The Rubinius source code is available as a tarball and as a project on Github.
You can <a href="http://rubini.us/download/latest">download the tarball here</a>.</p>
<p>To use Git:</p>
diff --git a/web/_site/doc/en/getting-started/troubleshooting/index.html b/web/_site/doc/en/getting-started/troubleshooting/index.html
index 2c69d29..e35da38 100644
--- a/web/_site/doc/en/getting-started/troubleshooting/index.html
+++ b/web/_site/doc/en/getting-started/troubleshooting/index.html
@@ -129,10 +129,10 @@ directory but you have not run 'rake install' yet.
<p>Solution:</p>
-<p>If you configured rubinius with a &ndash;prefix, run rake install.</p>
+<p>If you configured Rubinius with a <code>--prefix</code>, run rake install.</p>
-<p>If you configured rubinius with a &ndash;prefix and renamed the install directory
- after installing Rubinius, re-configure Rubinius and reinstall it.</p>
+<p>If you configured Rubinius with a <code>--prefix</code> and renamed the install
+ directory after installing Rubinius, re-configure Rubinius and reinstall it.</p>
<p>If you renamed the source directory after building Rubinius, re-configure
and rebuild it.</p>
diff --git a/web/_site/doc/en/how-to/write-a-ruby-spec/index.html b/web/_site/doc/en/how-to/write-a-ruby-spec/index.html
index d80fcb3..328e765 100644
--- a/web/_site/doc/en/how-to/write-a-ruby-spec/index.html
+++ b/web/_site/doc/en/how-to/write-a-ruby-spec/index.html
@@ -113,7 +113,7 @@
<li>Commit your changes</li>
<li>Use <code>git format-patch</code></li>
<li>Create a gist with your patch and link to it in a ticket on the issue
-tracker at http://github.com/evanphx/rubinius/issues.</li>
+tracker at <a href="http://github.com/evanphx/rubinius/issues">http://github.com/evanphx/rubinius/issues</a>.</li>
</ol>
diff --git a/web/_site/doc/en/how-to/write-documentation/index.html b/web/_site/doc/en/how-to/write-documentation/index.html
index 3ff089a..7043b82 100644
--- a/web/_site/doc/en/how-to/write-documentation/index.html
+++ b/web/_site/doc/en/how-to/write-documentation/index.html
@@ -158,7 +158,8 @@ documentation.</p>
<li>Create a new file with the .markdown extension under <code>web/doc/LANG</code>.</li>
<li>Set up the attributes to link the new file into the existing files. This
will require editing the <em>previous</em> and <em>next</em> attributes of the existing
-files to insert the new file.</li>
+files to insert the new file, as well as adding an entry to
+<code>index.markdown</code>.</li>
<li>To view your updates while you are working on them, run
<code>rbx -S jekyll --server --auto</code></li>
<li>Edit the new file using Markdown syntax.</li>
diff --git a/web/_site/doc/en/ruby/global-variables/index.html b/web/_site/doc/en/ruby/global-variables/index.html
index b0a083d..cee49c5 100644
--- a/web/_site/doc/en/ruby/global-variables/index.html
+++ b/web/_site/doc/en/ruby/global-variables/index.html
@@ -130,8 +130,8 @@ puts $SAFE
<p>Pseudo globals are a strict subset of names which refer not to global values
but values in the current scope, like local variables. These are still
-referred to as global variables because they start with a dollar sign, but this
-is the source of confusion for users.</p>
+referred to as global variables because they start with a dollar sign; this is
+a source of confusion for users.</p>
<p>All pseudo globals are organized around one primary pseudo global: <code>$~</code>. They
are all accessing parts of <code>$~</code> and thus when <code>$~</code> changes, they all
diff --git a/web/_site/doc/en/tools/debugger/index.html b/web/_site/doc/en/tools/debugger/index.html
index d18627f..8bda184 100644
--- a/web/_site/doc/en/tools/debugger/index.html
+++ b/web/_site/doc/en/tools/debugger/index.html
@@ -164,8 +164,8 @@ debug&gt; c
:light_brown
</code></pre>
-<p>Help for the debugger commands is available by typing <code>help</code> when in the
-debugger.</p>
+<p>As shown, help for the debugger commands is available by typing <code>help</code> when in
+the debugger.</p>
<h2 id="invoking-from-the-command-line">Invoking from the Command Line</h2>
diff --git a/web/_site/releases/index.html b/web/_site/releases/index.html
index 85c8558..1db1b68 100644
--- a/web/_site/releases/index.html
+++ b/web/_site/releases/index.html
@@ -61,7 +61,7 @@ release.</p>
<p>The Rubinius team also creates a binary installer for Apple OS X and, when it
is supported, for Microsoft Windows. We do not generally create packages for
other operating systems but we gladly assist package authors to do so. There
-are presently Rubinius packages for a variety of Linus and Unix operating
+are presently Rubinius packages for a variety of Linux and Unix operating
systems.</p>
<h3 id="current-release">Current Release</h3>
diff --git a/web/doc/en/appendix-a-glossary.markdown b/web/doc/en/appendix-a-glossary.markdown
index 41c560f..3fc8d1b 100644
--- a/web/doc/en/appendix-a-glossary.markdown
+++ b/web/doc/en/appendix-a-glossary.markdown
@@ -18,7 +18,7 @@ Guide" 2nd or 3rd Edition by Thomas et al [The Pragmatic Programmers
* _metaclass_
Also called the +singleton+ class or +eigenclass+. Every object in Ruby can
- have one, although, they are only created as necessary. The metaclass holds the
+ have one, although they are only created as necessary. The metaclass holds the
method and constant tables that belong only to a particular object instance.
For example, the method +hello+ defined below exists only in the metaclass for
+obj+.
@@ -47,12 +47,13 @@ Guide" 2nd or 3rd Edition by Thomas et al [The Pragmatic Programmers
* _method lookup or method resolution_
The rule is simple: Take the object located in the class slot of the object
- (which is not always the return value of Object#class) and begin searching.
+ (which is not always the return value of Object#class; if the object has one,
+ it'll be the metaclass) and begin searching.
Searching goes up the superclass chain until the superclass is nil.
In which case, redo lookup for method_missing. If we fail to find
- method_missing, fail tragicly.
+ method_missing, fail tragically.
+-------------+
| nil |
diff --git a/web/doc/en/appendix-b-reading-list.markdown b/web/doc/en/appendix-b-reading-list.markdown
index 402058a..8b99484 100644
--- a/web/doc/en/appendix-b-reading-list.markdown
+++ b/web/doc/en/appendix-b-reading-list.markdown
@@ -10,8 +10,8 @@ review: true
Building virtual machines in general and programming language implementations
in particular requires some knowledge. Rubinius' goal is to lower the barrier
-by keeping as much as possible in Ruby but to hack on garbage collector you
-have to understand what' going on behind the curtains.
+by keeping as much as possible in Ruby but to hack on the garbage collector you
+have to understand what's going on behind the curtains.
This page contains references to books, online lectures, blog posts and any
other publications you may find useful for working on Rubinius.
diff --git a/web/doc/en/bootstrapping.markdown b/web/doc/en/bootstrapping.markdown
index 622ed65..8e583f9 100644
--- a/web/doc/en/bootstrapping.markdown
+++ b/web/doc/en/bootstrapping.markdown
@@ -64,7 +64,7 @@ all Ruby code can be executed. There are seven stages to the bootstrap process:
7. loader: The compiled version of kernel/loader.rb is run.
- The final stage setups the life cycle of a ruby process. It starts by
+ The final stage sets up the life cycle of a ruby process. It starts by
connecting the VM to the system, sets up load paths, and reads
customization scripts from the home directory. It traps signals, and
processes command line arguments.
@@ -87,11 +87,11 @@ bodies is executed. For instance, when loading
attr_accessor :value
end
-the call to #attr_accessor will be run. This requires that any code called
-in script, class, or module bodies must be loaded before the file that calls
-the code is loaded. The kernel/alpha.rb defines most of the code that will be
-needed at the script or module level. However, other load order dependencies
-exist between some of the platform, common, delta, and compiler files.
+the call to #attr_accessor will be run. This requires that any code called in
+script, class, or module bodies be loaded before the file that calls the code.
+The kernel/alpha.rb defines most of the code that will be needed at the script
+or module level. However, other load order dependencies exist between some of
+the platform, common, delta, and compiler files.
These load order dependencies are addressed by the load_order.txt file located
in each of the kernel/\*\* directories. If you modify code that adds a load
diff --git a/web/doc/en/build-system.markdown b/web/doc/en/build-system.markdown
index 5c3ed9e..0d6a058 100644
--- a/web/doc/en/build-system.markdown
+++ b/web/doc/en/build-system.markdown
@@ -17,7 +17,7 @@ typically use makefiles.
## Development versus Install Builds
-Rubinius is comprised of the executable and various support files like the core
+Rubinius consists of the executable, and various support files like the core
and standard libraries. The executable needs to know where to find these files
even if moved to a different location. To handle this problem, Rubinius
distinguishes two build types: development and install. The executable stores
diff --git a/web/doc/en/contributing.markdown b/web/doc/en/contributing.markdown
index b4eb6c6..1607f3d 100644
--- a/web/doc/en/contributing.markdown
+++ b/web/doc/en/contributing.markdown
@@ -20,7 +20,7 @@ Below are several ideas for things to do on Rubinius.
## Run Your Code
Your code is often more vicious than the specs. Run your pet project under
-rubinius and report issues. See [How To Write a Ticket](/doc/en/how-to/write-a-ticket).
+Rubinius and report issues. See [How To Write a Ticket](/doc/en/how-to/write-a-ticket).
## Ask For Help
diff --git a/web/doc/en/getting-started/building.markdown b/web/doc/en/getting-started/building.markdown
index e4efa86..2a988a0 100644
--- a/web/doc/en/getting-started/building.markdown
+++ b/web/doc/en/getting-started/building.markdown
@@ -17,7 +17,7 @@ version of LLVM. If you have installed LLVM on your system, pass the
### Getting the Source
-The Rubinius source code available as a tarball and as a project on Github.
+The Rubinius source code is available as a tarball and as a project on Github.
You can [download the tarball here](http://rubini.us/download/latest).
To use Git:
diff --git a/web/doc/en/getting-started/troubleshooting.markdown b/web/doc/en/getting-started/troubleshooting.markdown
index b55cb91..fe60ada 100644
--- a/web/doc/en/getting-started/troubleshooting.markdown
+++ b/web/doc/en/getting-started/troubleshooting.markdown
@@ -38,10 +38,10 @@ Error:
Solution:
- If you configured rubinius with a --prefix, run rake install.
+ If you configured Rubinius with a `--prefix`, run rake install.
- If you configured rubinius with a --prefix and renamed the install directory
- after installing Rubinius, re-configure Rubinius and reinstall it.
+ If you configured Rubinius with a `--prefix` and renamed the install
+ directory after installing Rubinius, re-configure Rubinius and reinstall it.
If you renamed the source directory after building Rubinius, re-configure
and rebuild it.
diff --git a/web/doc/en/how-to/write-a-ruby-spec.markdown b/web/doc/en/how-to/write-a-ruby-spec.markdown
index 6a8c5b9..ec3f5d6 100644
--- a/web/doc/en/how-to/write-a-ruby-spec.markdown
+++ b/web/doc/en/how-to/write-a-ruby-spec.markdown
@@ -20,4 +20,4 @@ Then, follow these steps to write a spec for a Ruby method:
4. Commit your changes
7. Use `git format-patch`
8. Create a gist with your patch and link to it in a ticket on the issue
- tracker at http://github.com/evanphx/rubinius/issues.
+ tracker at <http://github.com/evanphx/rubinius/issues>.
diff --git a/web/doc/en/how-to/write-documentation.markdown b/web/doc/en/how-to/write-documentation.markdown
index fb3584f..200279d 100644
--- a/web/doc/en/how-to/write-documentation.markdown
+++ b/web/doc/en/how-to/write-documentation.markdown
@@ -67,7 +67,8 @@ To add documentation for which no existing topic exists:
1. Create a new file with the .markdown extension under `web/doc/LANG`.
1. Set up the attributes to link the new file into the existing files. This
will require editing the _previous_ and _next_ attributes of the existing
- files to insert the new file.
+ files to insert the new file, as well as adding an entry to
+ `index.markdown`.
1. To view your updates while you are working on them, run
`rbx -S jekyll --server --auto`
1. Edit the new file using Markdown syntax.
diff --git a/web/doc/en/ruby/global-variables.markdown b/web/doc/en/ruby/global-variables.markdown
index 6dd367f..59755bb 100644
--- a/web/doc/en/ruby/global-variables.markdown
+++ b/web/doc/en/ruby/global-variables.markdown
@@ -31,8 +31,8 @@ values depend on the thread, consider the following code:
Pseudo globals are a strict subset of names which refer not to global values
but values in the current scope, like local variables. These are still
-referred to as global variables because they start with a dollar sign, but this
-is the source of confusion for users.
+referred to as global variables because they start with a dollar sign; this is
+a source of confusion for users.
All pseudo globals are organized around one primary pseudo global: `$~`. They
are all accessing parts of `$~` and thus when `$~` changes, they all
diff --git a/web/doc/en/tools/debugger.markdown b/web/doc/en/tools/debugger.markdown
index 6b5b6a0..58c16ba 100644
--- a/web/doc/en/tools/debugger.markdown
+++ b/web/doc/en/tools/debugger.markdown
@@ -72,8 +72,8 @@ Running the code in Rubinius would produce the following:
debug> c
:light_brown
-Help for the debugger commands is available by typing `help` when in the
-debugger.
+As shown, help for the debugger commands is available by typing `help` when in
+the debugger.
## Invoking from the Command Line
diff --git a/web/releases.markdown b/web/releases.markdown
index b9513cc..e03e1c6 100644
--- a/web/releases.markdown
+++ b/web/releases.markdown
@@ -13,7 +13,7 @@ release.
The Rubinius team also creates a binary installer for Apple OS X and, when it
is supported, for Microsoft Windows. We do not generally create packages for
other operating systems but we gladly assist package authors to do so. There
-are presently Rubinius packages for a variety of Linus and Unix operating
+are presently Rubinius packages for a variety of Linux and Unix operating
systems.
### Current Release
--
1.7.2.3
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment