Browse files

Merge pull request #39 from kiela/master

Remove unnecessary backslashes
  • Loading branch information...
2 parents 0a6d100 + f267202 commit 71da2229106235e2b0b0e96e1774cdea1eaa84f3 @radar committed Feb 17, 2014
Showing with 6 additions and 6 deletions.
  1. +4 −4 engines.md
  2. +2 −2 gem-development.md
View
8 engines.md
@@ -30,12 +30,12 @@ By using
Let's go through what this command actually generates. It operates by a 4-part process, generating slightly different things at each step.
-For the first step, this command obviously needs to generate a directory to contain the engine in, and it does. This directory is called _for\_them_, the name that we gave our engine. The first step is setting up the skeleton for our engine to become a gem. By making this engine a gem, we can easily distribute it by uploading it to rubygems.org or rubyforge.org. This step generates the following files:
+For the first step, this command obviously needs to generate a directory to contain the engine in, and it does. This directory is called *for_them*, the name that we gave our engine. The first step is setting up the skeleton for our engine to become a gem. By making this engine a gem, we can easily distribute it by uploading it to rubygems.org or rubyforge.org. This step generates the following files:
-* _for\_them.gemspec_: (in the future, plainly referenced as "the _gemspec_") Contains a `Gem::Specification` for this engine, setting up things such as the name of the gem, its current version and any of its dependencies for either "real-world" operation or development.
+* *for_them.gemspec*: (in the future, plainly referenced as "the _gemspec_") Contains a `Gem::Specification` for this engine, setting up things such as the name of the gem, its current version and any of its dependencies for either "real-world" operation or development.
* _Gemfile_: Configuration file for Bundler. Configures "http://rubygems.org" to be the source for all gems and then determines what gems the engine depends on by looking them up from the _gemspec_.
-* _lib/for\_them.rb_: Defines a module for our gem called `ForThem` and nothing else. This is the base module where our engine class will be namespaced in.
-* _MIT\_LICENSE_: An MIT License file for the gem which is useful if we choose to release it under the MIT License.
+* *lib/for_them.rb*: Defines a module for our gem called `ForThem` and nothing else. This is the base module where our engine class will be namespaced in.
+* *MIT_LICENSE*: An MIT License file for the gem which is useful if we choose to release it under the MIT License.
* _README.rdoc_: Tells anybody who reads it that the "project rocks and uses the MIT-LICENSE". We can use this to tell users how to install or use our engine.
* _spec/dummy_: A very basic Rails application which we can use to test our engine.
View
4 gem-development.md
@@ -22,7 +22,7 @@ This command creates a [scaffold directory](gem-scaffold/foodie) for our new ge
* [**Gemfile**](gem-scaffold/foodie/Gemfile): Used to manage gem dependencies for our library's development. This file contains a `gemspec` line meaning that Bundler will include dependencies specified in _foodie.gemspec_ too. It's best practice to specify all the gems that our library depends on in the _gemspec_.
- * [**Rakefile**](gem-scaffold/foodie/Rakefile): Requires Bundler and adds the `build`, `install` and `release` Rake tasks by way of calling `Bundler::GemHelper.install\_tasks`. The `build` task will build the current version of the gem and store it under the _pkg_ folder, the `install` task will build _and_ install the gem to our system (just like it would do if we `gem install`'d it) and `release` will push the gem to Rubygems for consumption by the public.
+ * [**Rakefile**](gem-scaffold/foodie/Rakefile): Requires Bundler and adds the `build`, `install` and `release` Rake tasks by way of calling `Bundler::GemHelper.install_tasks`. The `build` task will build the current version of the gem and store it under the _pkg_ folder, the `install` task will build _and_ install the gem to our system (just like it would do if we `gem install`'d it) and `release` will push the gem to Rubygems for consumption by the public.
* [**.gitignore**](gem-scaffold/foodie/.gitignore): (only if we have Git). This ignores anything in the _pkg_ directory (generally files put there by `rake build`), anything with a _.gem_ extension and the _.bundle_ directory.
@@ -142,7 +142,7 @@ However, relying on a version simply greater than the latest-at-the-time is a su
s.add_dependency "activesupport", "~> 4.0.0"
```
-When we run `bundle install` again, the `activesupport` gem will be installed for us to use. Of course, like the diligent TDD/BDD zealots we are, we will test our `pluralize` method before we code it. Let's add this test to _spec/food\_spec.rb_ now inside our `describe Foodie::Food` block:
+When we run `bundle install` again, the `activesupport` gem will be installed for us to use. Of course, like the diligent TDD/BDD zealots we are, we will test our `pluralize` method before we code it. Let's add this test to *spec/food_spec.rb* now inside our `describe Foodie::Food` block:
```ruby
it "pluralizes a word" do

0 comments on commit 71da222

Please sign in to comment.