polished documentation

This commit is contained in:
Chris Anderson 2008-09-29 23:39:57 -07:00
parent 26c4db7fc6
commit b3b58ffa83
6 changed files with 20 additions and 11 deletions

View file

@ -5,6 +5,12 @@ module CouchRest
class Database
attr_reader :server, :host, :name, :root
# Create a CouchRest::Database adapter for the supplied CouchRest::Server and database name.
#
# ==== Parameters
# server<CouchRest::Server>:: database host
# name<String>:: database name
#
def initialize server, name
@name = name
@server = server
@ -12,6 +18,7 @@ module CouchRest
@root = "#{host}/#{name}"
end
# returns the database's uri
def to_s
@root
end