Skip to content

Commit

Permalink
Small documentation fixes.
Browse files Browse the repository at this point in the history
- Change the example for REST.delete slightly.
- Remove :nodoc: from REST module definitions because it clobbers earlier module documentation.
  • Loading branch information
Manfred committed Dec 10, 2008
1 parent 0f3e777 commit 9c052ea
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion lib/rest.rb
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ def self.head(uri, headers={}, options={})
#
# response = REST.delete('http://example.com/pigeons/12')
# if response.ok?
# puts "Your pigeon exists!"
# puts "Your pigeon died ): )"
# elsif response.found?
# puts "Someone moved your pigeon!"
# else
Expand Down
2 changes: 1 addition & 1 deletion lib/rest/request.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
require 'uri'
require 'net/http'

module REST #:nodoc:
module REST
# Request holds a HTTP request
class Request
attr_accessor :verb, :url, :body, :headers, :options, :request
Expand Down
2 changes: 1 addition & 1 deletion lib/rest/response.rb
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module REST #:nodoc:
module REST
# Response holds a HTTP response
class Response
# These codes are used to define convenience boolean accessors on the response object.
Expand Down

0 comments on commit 9c052ea

Please sign in to comment.