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

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

説明

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
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
half day
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.