Permalink
Browse files

Some docs.

  • Loading branch information...
1 parent 5204973 commit 94996c93b7509f76080cb6fd77bd07158ab69d3d Daz Oakley committed Jan 19, 2011
Showing with 13 additions and 0 deletions.
  1. +13 −0 lib/biomart/dataset.rb
View
@@ -6,6 +6,19 @@ class Dataset
attr_reader :name, :display_name, :visible
+ # Creates a new Biomart::Dataset object.
+ #
+ # @param [String] url The URL location of the biomart server.
+ # @param [Hash] args An arguments hash giving details of the dataset.
+ #
+ # arguments hash:
+ #
+ # {
+ # :name => String, #
+ # "name" => String, #
+ # :display_name => {} #
+ #
+ # }
def initialize( url, args )
@url = url or raise ArgumentError, "must pass :url"
unless @url =~ /martservice/

0 comments on commit 94996c9

Please sign in to comment.