Skip to content

Commit

Permalink
Update README and change internal documentation slightly.
Browse files Browse the repository at this point in the history
  • Loading branch information
David Czarnecki committed Jul 27, 2012
1 parent 995f49f commit 8939fdc
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
3 changes: 3 additions & 0 deletions README.markdown
Expand Up @@ -176,6 +176,9 @@ Below is an example of retrieving the first page in the leaderboard without scor

You can also use the `members` and `members_in` methods as aliases for the `leaders` and `leaders_in` methods.

There are also a few convenience methods to be able to retrieve all leaders from a given leaderboard. They are `all_leaders` and `all_leaders_from`. You
may also use the aliases `all_members` or `all_members_from`. Use any of these methods sparingly as all the information in the leaderboard will be returned.

Add more members to your leaderboard:

```ruby
Expand Down
4 changes: 2 additions & 2 deletions lib/leaderboard.rb
Expand Up @@ -578,7 +578,7 @@ def leaders_in(leaderboard_name, current_page, options = {})

# Retrieve all leaders from the leaderboard.
#
# @param options [Hash] Options to be used when retrieving the page from the leaderboard.
# @param options [Hash] Options to be used when retrieving the leaders from the leaderboard.
#
# @return the leaders from the leaderboard.
def all_leaders(options = {})
Expand All @@ -590,7 +590,7 @@ def all_leaders(options = {})
# Retrieves all leaders from the named leaderboard.
#
# @param leaderboard_name [String] Name of the leaderboard.
# @param options [Hash] Options to be used when retrieving the page from the named leaderboard.
# @param options [Hash] Options to be used when retrieving the leaders from the named leaderboard.
#
# @return the named leaderboard.
def all_leaders_from(leaderboard_name, options = {})
Expand Down

0 comments on commit 8939fdc

Please sign in to comment.