Skip to content

Commit

Permalink
Minor grammatical update.
Browse files Browse the repository at this point in the history
- Bold notes, warnings, etc. titles
- Move convention into a sub-heading
  • Loading branch information
cupakromer committed Apr 5, 2014
1 parent f44ec40 commit c468279
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 6 deletions.
2 changes: 1 addition & 1 deletion features/Upgrade.md
Expand Up @@ -239,7 +239,7 @@ passed to `it_should_behave_like`.

See [features/example\_groups/shared\_example\_group.feature](http://github.com/rspec/rspec-core/blob/master/features/example_groups/shared_example_group.feature) for more information.

NOTICE: The including example groups no longer have access to any of the
**NOTICE:** The including example groups no longer have access to any of the
methods, hooks, or state defined inside a shared group. This will break rspec-1
specs that were using shared example groups to extend the behavior of including
groups.
Expand Down
2 changes: 1 addition & 1 deletion features/configuration/default_path.feature
Expand Up @@ -7,7 +7,7 @@ Feature: Setting the default spec path
an individual file to `--default-path`, you can do so on the command line or
in a configuration file (`.rspec`, `~/.rspec`, or a custom file).

NOTE: this option is not supported on `RSpec.configuration`, as it needs to be
**NOTE:** this option is not supported on `RSpec.configuration`, as it needs to be
set before spec files are loaded.

Scenario: Run `rspec` with default `default-path` (`spec` directory)
Expand Down
5 changes: 3 additions & 2 deletions features/example_groups/shared_examples.feature
Expand Up @@ -14,12 +14,13 @@ Feature: shared examples
matching metadata # include the examples in the current context
```

WARNING: Files containing shared groups must be loaded before the files that
**WARNING:** Files containing shared groups must be loaded before the files that
use them. While there are conventions to handle this, RSpec does _not_ do
anything special (like autoload). Doing so would require a strict naming
convention for files that would break existing suites.

CONVENTIONS:
Conventions:
------------

1. The simplest approach is to require files with shared examples explicitly
from the files that use them. Keep in mind that RSpec adds the `spec`
Expand Down
4 changes: 2 additions & 2 deletions features/hooks/around_hooks.feature
Expand Up @@ -10,11 +10,11 @@ Feature: `around` hooks
receives a block, you can use an `around` to cleanly open and close the
transaction around the example.

**WARNING**: `around` hooks do not share state with the example the way
**WARNING:** `around` hooks do not share state with the example the way
`before` and `after` hooks do. This means that you cannot share instance
variables between `around` hooks and examples.

**WARNING**: Mock frameworks are set up and torn down within the context of
**WARNING:** Mock frameworks are set up and torn down within the context of
running the example. You cannot interact with them directly in `around` hooks.

Scenario: Use the example as a proc within the block passed to `around()`
Expand Down

0 comments on commit c468279

Please sign in to comment.