Skip to content

Commit

Permalink
Fixing up the docstring for get_segment_leaderboard since the behavio…
Browse files Browse the repository at this point in the history
…r is slightly different when getting a segment the current user hasn't ridden. Also, the bottom 5 isn't returned, but the 5 results including the current user are also included.
  • Loading branch information
b-jazz committed Dec 26, 2014
1 parent ac1acb8 commit 6c48ec4
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions stravalib/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -753,10 +753,11 @@ def get_segment_leaderboard(self, segment_id, gender=None, age_group=None, weigh
http://strava.github.io/api/v3/segments/#leaderboard
Note that by default Strava will return the top 10 results *and then will also include
the bottom 5 results*. The top X results can be configured by setting the top_results_limit
parameter; however,the bottom 5 results are always included. (i.e. if you specify top_results_limit=15,
you will get a total of 20 entries back.)
Note that by default Strava will return the top 10 results, and if the current user has ridden
that segment, the current user's result along with the two results above in rank and the two
results below will be included. The top X results can be configured by setting the top_results_limit
parameter; however, the other 5 results will be included if the current user has ridden that segment.
(i.e. if you specify top_results_limit=15, you will get a total of 20 entries back.)
:param segment_id: ID of the segment.
:type segment_id: int
Expand Down

0 comments on commit 6c48ec4

Please sign in to comment.