Skip to content

Commit

Permalink
Replace +text+ RDoc syntax with <tt>text</tt> HTML syntax, more rock-…
Browse files Browse the repository at this point in the history
…solid.
  • Loading branch information
Rémy Coutable committed Feb 28, 2011
1 parent 2e94bf8 commit ca2f14e
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
6 changes: 3 additions & 3 deletions CHANGELOG.rdoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
=== Mar 1, 2011 by {Jimmy Cuadra}[https://github.com/jimmycuadra] and {Rémy Coutable}[https://github.com/rymai]

New features:
- New +:cli+ option for passing RSpec CLI option to the runner, thanks to {Jimmy Cuadra}[https://github.com/jimmycuadra].
- Deprecation of +:color+, +:drb+, +:fail_fast+ and +:formatter+ options.
- New +:notification+ option (to disable Growl/Libnotify notifications).
- New <tt>:cli</tt> option for passing RSpec CLI option to the runner, thanks to {Jimmy Cuadra}[https://github.com/jimmycuadra].
- Deprecation of <tt>:color</tt>, <tt>:drb</tt>, <tt>:fail_fast</tt> and <tt>:formatter</tt> options.
- New <tt>:notification</tt> option (to disable Growl/Libnotify notifications).
12 changes: 6 additions & 6 deletions README.rdoc
Original file line number Diff line number Diff line change
Expand Up @@ -53,19 +53,19 @@ Please read {Guard doc}[https://github.com/guard/guard#readme] for more informat

== Options

By default, Guard::RSpec automatically detect your RSpec version (with the +spec_helper.rb+ syntax or with Bundler) but you can force the version with the +:version+ option:
By default, Guard::RSpec automatically detect your RSpec version (with the <tt>spec_helper.rb</tt> syntax or with Bundler) but you can force the version with the <tt>:version</tt> option:

guard 'rspec', :version => 2 do
...
end

You can pass any of the standard RSpec CLI options using the +:cli+ option:
You can pass any of the standard RSpec CLI options using the <tt>:cli</tt> option:

guard 'rspec', :cli => "--color --format nested --fail-fast --drb" do
...
end

Former +:color+, +:drb+, +:fail_fast+ and +:formatter+ options are thus deprecated and have no effect anymore.
Former <tt>:color</tt>, <tt>:drb</tt>, <tt>:fail_fast</tt> and <tt>:formatter</tt> options are thus deprecated and have no effect anymore.

=== List of available options:

Expand All @@ -77,7 +77,7 @@ Former +:color+, +:drb+, +:fail_fast+ and +:formatter+ options are thus deprecat

== Formatters

The +:formatter+ option has been removed since CLI arguments can be passed through the +:cli+ option. If you want to use the former Instafail formatter, you need to use +rspec-instafail+ gem instead:
The <tt>:formatter</tt> option has been removed since CLI arguments can be passed through the <tt>:cli</tt> option. If you want to use the former Instafail formatter, you need to use <tt>rspec-instafail</tt> gem instead:

# in your Gemfile
gem 'rspec-instafail'
Expand All @@ -87,7 +87,7 @@ The +:formatter+ option has been removed since CLI arguments can be passed throu
...
end

Default formatter is the +progress+ formatter (same as RSpec default).
Default formatter is the <tt>progress</tt> formatter (same as RSpec default).

== Development

Expand All @@ -99,7 +99,7 @@ you make.

=== Testing

Please run +rake spec:prepare_fixtures+ once before launching specs.
Please run <tt>rake spec:prepare_fixtures</tt> once before launching specs.

== Authors

Expand Down

0 comments on commit ca2f14e

Please sign in to comment.