Skip to content
This repository was archived by the owner on Nov 30, 2024. It is now read-only.

Commit 4dd013d

Browse files
committed
Prefer capitalized section headings.
1 parent ae69d80 commit 4dd013d

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ rspec-core provides the structure for writing executable examples of how your
44
code should behave, and an `rspec` command with tools to constrain which
55
examples get run and tailor the output.
66

7-
## install
7+
## Install
88

99
gem install rspec # for rspec-core, rspec-expectations, rspec-mocks
1010
gem install rspec-core # for rspec-core only
@@ -19,7 +19,7 @@ RSpec repos as well. Add the following to your `Gemfile`:
1919
end
2020
```
2121

22-
## basic structure
22+
## Basic Structure
2323

2424
RSpec uses the words "describe" and "it" so we can express concepts like a conversation:
2525

@@ -49,7 +49,7 @@ Under the hood, an example group is a class in which the block passed to
4949
`describe` is evaluated. The blocks passed to `it` are evaluated in the
5050
context of an _instance_ of that class.
5151

52-
## nested groups
52+
## Nested Groups
5353

5454
You can also declare nested nested groups using the `describe` or `context`
5555
methods:
@@ -70,7 +70,7 @@ RSpec.describe Order do
7070
end
7171
```
7272

73-
## aliases
73+
## Aliases
7474

7575
You can declare example groups using either `describe` or `context`.
7676
For a top level example group, `describe` and `context` are available
@@ -81,7 +81,7 @@ patching.
8181
You can declare examples within a group using any of `it`, `specify`, or
8282
`example`.
8383

84-
## shared examples and contexts
84+
## Shared Examples and Contexts
8585

8686
Declare a shared example group using `shared_examples`, and then include it
8787
in any group using `include_examples`.
@@ -111,7 +111,7 @@ pretty much the same as `shared_examples` and `include_examples`, providing
111111
more accurate naming when you share hooks, `let` declarations, helper methods,
112112
etc, but no examples.
113113

114-
## metadata
114+
## Metadata
115115

116116
rspec-core stores a metadata hash with every example and group, which
117117
contains their descriptions, the locations at which they were
@@ -162,26 +162,26 @@ RSpec.describe Hash do
162162
end
163163
```
164164

165-
## the `rspec` command
165+
## The `rspec` Command
166166

167167
When you install the rspec-core gem, it installs the `rspec` executable,
168168
which you'll use to run rspec. The `rspec` command comes with many useful
169169
options.
170170
Run `rspec --help` to see the complete list.
171171

172-
## store command line options `.rspec`
172+
## Store Command Line Options `.rspec`
173173

174174
You can store command line options in a `.rspec` file in the project's root
175175
directory, and the `rspec` command will read them as though you typed them on
176176
the command line.
177177

178-
## autotest integration
178+
## Autotest Integration
179179

180180
rspec-core no longer ships with an Autotest extension, if you require Autotest
181181
integration, please use the `rspec-autotest` gem and see [rspec/rspec-autotest](https://github.com/rspec/rspec-autotest)
182182
for details
183183

184-
## get started
184+
## Get Started
185185

186186
Start with a simple example of behavior you expect from your system. Do
187187
this before you write any implementation code:

0 commit comments

Comments
 (0)