Update HackerNews.jl

src/HackerNews.jl

@@ -4,8 +4,10 @@ module HackerNews
 using HTTP
 using JSON
 
+# Abstract Type
 abstract type HNApiRoute end 
 
+# HNApiRoute Subtypes
 type MaxItem <: HNApiRoute end
 type TopStories <: HNApiRoute end 
 type NewStories <: HNApiRoute end 
@@ -15,6 +17,7 @@ type ShowStories <: HNApiRoute end
 type JobStories <: HNApiRoute end 
 type Updates <: HNApiRoute end
 
+# Declaring the values
 hn_route_string(::Type{MaxItem}) = "maxitem"
 hn_route_string(::Type{TopStories}) = "topstories"
 hn_route_string(::Type{NewStories}) = "newstories"
@@ -100,16 +103,25 @@ type HNUser
             submitted=  get(data, "submitted", nothing)) = new(data, id, delay, created, karma, about, submitted)
 end
 
+"""
+Parse response for updates
+"""
 function parse_hn_response(::Type{Updates}, response, hn)
     info("fetching updates..")
     JSON.parse(convert(String, response.body))[hn.user_related ? "profiles":"items"]  
 end
 
+"""
+Parse response for maxitem
+"""
 function parse_hn_response(::Type{MaxItem}, response, hn)
     info("fetching maxitem..")
     parse(convert(String, response.body))    
 end
 
+"""
+Parse response
+"""
 function parse_hn_response(story, response, hn) 
     info("fetching $(story)...")
     eval(parse(convert(String, response.body)))[1:hn.nposts]