8thlight/limelight_docs — pull request #1 by rab1234 (2012-12-13 20:44:06+00:00)
Title: Fix typos

Micah, per our earlier discussion this week, I forked the limelight_docs and have made some changes. I don't know if you really want to spend time reviewing changes to documentation of an old version of Limelight, but this process has been helpful to me to familiarize myself with Limelight. (If you recall, I had to install Limelight -v 0.5.5 to get this to work.)

If you think you may want to accept my proposed changes, I thought I would point a few things out to you to minimize your effort. (If not, just let me know that the documentation is too old to worry about.) First, about 1/2 of the proposed commits are corrections of typos only. I tried to segregate the changes in my commits between typos only, and other more significant changes. There are a couple of proposed commits that I thought you would want to look at more closely:

(1) commit 0819c - "added step 3a ..."

This proposed change adds a new step (numbered 3a) to the getting_started.rb file. It instructs the user to install an old version of RSpec. Obviously, if they don't, then the rspec tests in getting_started.rb will fail and the user may not find the reason in the Google Groups email list like I did.

(2) commit d39bc - "correct display of code ..."

When going through the documentation I noticed that the code displayed in the code blocks is often "cut off", or otherwise does not display correctly. I first ran into this on step 12 of getting_started.rb. Several of the commas in the hash did not display. With a little tinkering I discovered that if I inserted apostrophes after each undisplayed comma, it would be correctly displayed. (I tried changing padding, margins, etc and could not find any solution along those lines.) That is the correction that I made in this commit.

I have since discovered that there are other display issues. For example, often parentheses fail to display properly in the code blocks. I do not know if this is a problem with my setup or if it is a problem with Limelight.

(3) commit 50901 - "changed value of width parameter ..."

This was not really an error in the code. The code was demonstrating the :center style. It set the width = 200, but the apparent display area was considerably larger than that. Thus, when the text was centered it looked like it was merely indented and not centered. That annoyed me.

(4) commit b8067 - "correct typos and rephrase ..."

I made a number of changes to the "directions" given to the user in players_built_in.rb in the hope that they would be somewhat more clear. Those "editorial" changes are in this commit.

==============

NOTE: I next came to the combo_box section of players_built_in.rb. As you may already know, the combo_box crashes the program. I tinkered with it for a while and was unable to find the cause or a fix. As I mentioned above, since this is documentation for an old version of Limelight, I am not sure you want to spend the time to fix this problem with the combo_box, but it would be nice if that could be fixed. (And, of course, it could be a problem with my setup and not Limelight.)

Let me know if you think any of this is useful.

RAB