Cog-Creators/Red-DiscordBot

[Bank API] Make it so `get_leaderboard_position` returns a tuple with user position and total entries in leaderboard

Open

#4,200 opened on Aug 18, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (2,317 forks)batch import
Category: Core - API - BankGood First IssueStatus: In ProgressType: Enhancement

Repository metrics

Stars
 (4,337 stars)
PR merge metrics
 (Avg merge 1d 15h) (3 merged PRs in 30d)

Description

Feature request

Select the type of feature you are requesting:

  • Cog
  • Command
  • API functionality

Describe your requested feature

As the title suggest, this would allow making displays without having to make more expensive calls.

Make it into an kwarg so that it is not breaking and allows existing behaviour when not used.

Alternativelly add a new API call that returns this tuple

Contributor guide

Research direction
Modify the `get leaderboard position` function to return a tuple (position, total entries) when a new keyword argument is passed, or add a new API call that returns this tuple.
Tech stack
python
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90