Documentation

mpolakis · Nov 7, 2011 · 0ac5038 · 0ac5038
1 parent 0ac82c2
commit 0ac5038
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 2 deletions.
diff --git a/lib/crunchbase/cb_object.rb b/lib/crunchbase/cb_object.rb
@@ -1,4 +1,6 @@
 module Crunchbase
+
+  # Represents any object which can be pulled directly from the CB API.
   class CB_Object
 
     # Returns an array of tags

diff --git a/lib/crunchbase/company.rb b/lib/crunchbase/company.rb
@@ -13,7 +13,8 @@ class Company < CB_Object
       :providerships, :total_money_raised, :funding_rounds, :investments,
       :acquisition, :acquisitions, :offices, :milestones, :ipo, :video_embeds,
       :screenshots, :external_links
-
+
+    # Factory method to return a Company instance from a permalink  
     def self.get(permalink)
       j = API.company(permalink)
       c = Company.new(j)

diff --git a/lib/crunchbase/financial_organization.rb b/lib/crunchbase/financial_organization.rb
@@ -11,6 +11,7 @@ class FinancialOrganization < CB_Object
       :overview, :image, :offices, :relationships, :investments, :milestones,
       :providerships, :funds, :video_embeds, :external_links
 
+    # Factory method to return a FinancialOrganization instance from a permalink
     def self.get(permalink)
       j = API.financial_organization(permalink)
       f = FinancialOrganization.new(j)

diff --git a/lib/crunchbase/person.rb b/lib/crunchbase/person.rb
@@ -11,6 +11,7 @@ class Person < CB_Object
       :overview, :relationships, :investments, :milestones, :video_embeds,
       :external_links, :web_presences
 
+    # Factory method to return a Person instance from a permalink
     def self.get(permalink)
       j = API.person(permalink)
       p = Person.new(j)

diff --git a/lib/crunchbase/relationship.rb b/lib/crunchbase/relationship.rb
@@ -1,4 +1,6 @@
 module Crunchbase
+  # Superclass for all relationships. Used for both the relationships and
+  # providerships arrays on retrieved objects.
   class Relationship
 
     attr_reader :title

diff --git a/lib/crunchbase/service_provider.rb b/lib/crunchbase/service_provider.rb
@@ -5,7 +5,8 @@ class ServiceProvider < CB_Object
     attr_reader :name, :permalink, :crunchbase_url, :homepage_url,
       :phone_number, :tag_list, :alias_list, :created_at, :updated_at,
       :overview, :image, :offices, :providerships, :external_links
-
+
+    # Factory method to return a ServiceProvider instance from a permalink      
     def self.get(permalink)
       j = API.service_provider(permalink)
       s = ServiceProvider.new(j)