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 创建于 2020年8月18日

在 GitHub 查看
 (0 评论) (0 反应) (0 负责人)Python (4,337 star) (2,317 fork)batch import
Category: Core - API - BankGood First IssueStatus: In ProgressType: Enhancement

描述

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

贡献者指南

技术栈
python
领域
api
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
half day
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
PythonDiscord bot programmingRed DiscordBot codebase
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
60
研究方向
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.