Skip to content

Commit fbea2a0

Browse files
committed
Remove whitespace from the readme
[ci skip]
1 parent 39d2ef1 commit fbea2a0

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,12 @@ Add rspec_api_documentation to your Gemfile
2323
Bundle it!
2424

2525
$ bundle install
26-
26+
2727
Set up specs.
2828

2929
$ mkdir spec/acceptance
3030
$ vim spec/acceptance/orders_spec.rb
31-
31+
3232
```ruby
3333
require 'spec_helper'
3434
require 'rspec_api_documentation/dsl'
@@ -37,7 +37,7 @@ resource "Orders" do
3737
get "/orders" do
3838
example "Listing orders" do
3939
do_request
40-
40+
4141
status.should == 200
4242
end
4343
end
@@ -59,7 +59,7 @@ Consider adding a viewer to enhance the generated documentation. By itself rspec
5959
#### Gemfile
6060

6161
gem 'raddocs'
62-
62+
6363
#### spec/spec_helper.rb
6464

6565
```ruby
@@ -79,24 +79,24 @@ See the `example` folder for a sample Rails app that has been documented.
7979
RspecApiDocumentation.configure do |config|
8080
# Set the application that Rack::Test uses
8181
config.app = Rails.application
82-
82+
8383
# Output folder
8484
config.docs_dir = Rails.root.join("doc", "api")
85-
85+
8686
# An array of output format(s).
8787
# Possible values are :json, :html, :combined_text, :combined_json,
8888
# :json_iodocs, :textile, :markdown, :append_json
8989
config.format = [:html]
90-
90+
9191
# Location of templates
9292
config.template_path = "inside of the gem"
93-
93+
9494
# Filter by example document type
9595
config.filter = :all
96-
96+
9797
# Filter by example document type
9898
config.exclusion_filter = nil
99-
99+
100100
# Used when adding a cURL output to the docs
101101
config.curl_host = nil
102102

@@ -114,24 +114,24 @@ RspecApiDocumentation.configure do |config|
114114
# By default examples and resources are ordered by description. Set to true keep
115115
# the source order.
116116
config.keep_source_order = false
117-
117+
118118
# Change the name of the API on index pages
119119
config.api_name = "API Documentation"
120-
120+
121121
# Redefine what method the DSL thinks is the client
122122
# This is useful if you need to `let` your own client, most likely a model.
123123
config.client_method = :client
124124

125125
# Change the IODocs writer protocol
126126
config.io_docs_protocol = "http"
127-
127+
128128
# You can define documentation groups as well. A group allows you generate multiple
129129
# sets of documentation.
130130
config.define_group :public do |config|
131131
# By default the group's doc_dir is a subfolder under the parent group, based
132132
# on the group's name.
133133
config.docs_dir = Rails.root.join("doc", "api", "public")
134-
134+
135135
# Change the filter to only include :public examples
136136
config.filter = :public
137137
end
@@ -199,33 +199,33 @@ You tag examples with either a single symbol or an array of symbols.
199199
resource "Account" do
200200
get "/accounts" do
201201
parameter :page, "Page to view"
202-
202+
203203
# default :document is :all
204204
example "Get a list of all accounts" do
205205
do_request
206206
status.should == 200
207207
end
208-
208+
209209
# Don't actually document this example, purely for testing purposes
210210
example "Get a list on page 2", :document => false do
211211
do_request(:page => 2)
212212
status.should == 404
213213
end
214-
214+
215215
# With example_request, you can't change the :document
216216
example_request "Get a list on page 3", :page => 3 do
217217
status.should == 404
218218
end
219219
end
220-
220+
221221
post "/accounts" do
222222
parameter :email, "User email"
223-
223+
224224
example "Creating an account", :document => :private do
225225
do_request(:email => "eric@example.com")
226226
status.should == 201
227227
end
228-
228+
229229
example "Creating an account - errors", :document => [:private, :developers] do
230230
do_request
231231
status.should == 422
@@ -242,12 +242,12 @@ RspecApiDocumentation.configure do |config|
242242
config.define_group :non_private do |config|
243243
config.exclusion_filter = :private
244244
end
245-
245+
246246
# Only document examples marked as 'public'
247247
config.define_group :public do |config|
248248
config.filter = :public
249249
end
250-
250+
251251
# Only document examples marked as 'developer'
252252
config.define_group :developers do |config|
253253
config.filter = :developers
@@ -363,7 +363,7 @@ end
363363

364364
#### parameter
365365

366-
This method takes the parameter name, a description, and an optional hash of extra metadata that can be displayed in Raddocs as extra columns. If a method with the parameter name exists, e.g. a `let`, it will send the returned value up to the server as URL encoded data.
366+
This method takes the parameter name, a description, and an optional hash of extra metadata that can be displayed in Raddocs as extra columns. If a method with the parameter name exists, e.g. a `let`, it will send the returned value up to the server as URL encoded data.
367367

368368
Special values:
369369

0 commit comments

Comments
 (0)