Merge pull request #18 from mguinada/review-docs

Documentation review

.yardopts

@@ -1,2 +1,2 @@
---no-private --protected --markup markdown lib/**/*.rb - README.md LICENSE
+--no-private --protected --markup-provider redcarpet --markup markdown lib/**/*.rb - README.md LICENSE
 

CHANGELOG.md

@@ -0,0 +1,14 @@
+0.1.0
+-----
+
+Added track streaming URI acquisition (Tracks#stream)
+
+0.0.2
+-----
+
+Added the per_page parameter & corrected pagination threshold
+
+0.0.1
+-----
+
+1st release

README.md

@@ -59,6 +59,7 @@ track.metadata.artist.name
 
 ### Search for an artist
 ```ruby
+
 api.search_artists('radiohead').map(&:name)
 => ["Radiohead", "Radiohead at Lollapalooza 2008", "REM & Radiohead", "Radiohead 6. Permanent Daylight live", "Radiohead @ Optimus Alive'12", "I Can't Take The Hurt (Johnny Cash vs Tegan and Sarah and Radiohead)"]
 ```
@@ -67,7 +68,7 @@ api.search_artists('radiohead').map(&:name)
 ```ruby
 
 activity = []
-api.genre_channels('punk', 'rock').each do |act|
+api.genre_channels('punk', 'rock', page: 1, per_page: 10).each do |act|
   activity << "#{act.verb.capitalize} on #{act.actor.title} refering music track #{act.object.metadata.title}"
 end
 

Rakefile

@@ -23,7 +23,7 @@ namespace :doc do
   desc "Generate documentation"
   YARD::Rake::YardocTask.new do |t|
     t.files   = ['lib/**/*.rb']
-    t.options = ['--no-private', '--protected', '--markup', 'markdown']
+    t.options = ['--no-private', '--protected', '--markup-provider', 'redcarpet', '--markup', 'markdown']
   end
 end
 

lib/shuffler_fm/api/channels.rb

@@ -13,15 +13,15 @@ module Channels
       # @return [Array] an array with the channel's activity stream
       #
       # @example
-      #   api.media_channels('youtube', page: 2)
+      #   api.media_channels('soundcloud')
       #
       def media_channels(key, options = {})
         channel(:media, key, options)
       end
 
       # Reads the blog channels activity stream
       #
-      # @param [String] key The channel key.
+      # @param [Integer] key The blog id
       # @param [Hash] options
       # @option options [Integer] :page The page to request on paginated operation responses. First page is page 1.
       # @option options [Integer] :per_page The page size. Default is 50, maximum is 100.
@@ -37,7 +37,6 @@ def blog_channels(key, options = {})
 
       # Reads the artist channels activity stream
       #
-      # @param key The channel key.
       # @param [Hash] options
       # @option options [Integer] :page The page to request on paginated operation responses. First page is page 1.
       # @option options [Integer] :per_page The page size. Default is 50, maximum is 100.
@@ -53,16 +52,22 @@ def artist_channels(key, options = {})
 
       # Reads the genere channels activity stream.
       #
-      # @param [Array] keys The channel keys.
-      # @param [Hash] options
-      # @option options [Integer] :page The page to request on paginated operation responses. First page is page 1.
-      # @option options [Integer] :per_page The page size. Default is 50, maximum is 100.
+      # @overload genre_channels(*keys)
+      #   @param [Array] keys The channel keys.
       #
-      # @return [Array] an array with the channel's activity stream
+      #   @example
+      #      api.genre_channels('punk')
+      #      api.genre_channels('punk', 'rock')
       #
-      # @example
-      #    api.genre_channels('rock')
-      #    api.genre_channels('punk', 'rock', page: 2)
+      # @overload genre_channels(*keys, options)
+      #   @param [Hash] options
+      #   @option options [Integer] :page The page to request on paginated operation responses. First page is page 1.
+      #   @option options [Integer] :per_page The page size. Default is 50, maximum is 100.
+      #
+      #   @example
+      #      api.genre_channels('punk', 'rock', page: 1, per_page: 10)
+      #
+      # @return [Array] an array with the channel's activity stream
       #
       def genre_channels(*keys)
         channel(:genre, *keys)

lib/shuffler_fm/api/tracks.rb

@@ -32,7 +32,7 @@ def track(id)
 
       # Streaming URI for a track.
       #
-      # NOTE: This operation required a specific authorization form shuffler.fm
+      # NOTE: This operation requires a specific authorization form shuffler.fm
       #
       # @param [Integer] id The track id
       #

shuffler_fm.gemspec

@@ -33,5 +33,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'vcr'
   gem.add_development_dependency 'simplecov'
   gem.add_development_dependency 'yard'
-  gem.add_development_dependency 'maruku'
+  gem.add_development_dependency 'redcarpet'
+  gem.add_development_dependency 'github-markup'
 end