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 (4,337 stars) (2,317 forks)batch import
Category: Core - API - BankGood First IssueStatus: In ProgressType: Enhancement

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

Tech stack
python
Domain
api
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
PythonDiscord bot programmingRed DiscordBot codebase
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Locate the existing `get leaderboard position` function in the bank API, likely in `redbot/cogs/bank.py` or similar. Examine its current return value and signature. Implement a new keyword argument or create a new API endpoint that returns a tuple `(position, total entries)`. Ensure backward compatibility by not breaking existing calls. Consider adding a new method `get leaderboard position detailed` or modifying with default parameter. Test locally with the bot.