Remove unavailable and deprecated name_forindex function from documentation

[BatteRaquette581]

name_forindex(index) is deprecated, but now unavailable in pygame._sdl2.controller (it now resides in pygame._sdl2.controller_old), and it seems like it should not be used.

[coderabbitai]

📝 Walkthrough

Walkthrough

Documentation for the public function name_forindex has been removed from the pygame._sdl2.controller module reference documentation. This eliminates the function's definition and usage documentation from the API reference.

Changes

Cohort / File(s)	Summary
Documentation removal docs/reST/ref/sdl2_controller.rst	Removed the name_forindex function reference block and its associated documentation marker from the SDL2 controller API reference.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

• The change is confined to documentation deletion with no code modifications
• Verify that no other documentation files or examples reference the removed function
• Confirm whether this removal aligns with corresponding code changes in the main library

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main change: removing a deprecated and unavailable function from documentation.
Description check	✅ Passed	The description is related to the changeset, explaining the rationale for removing the function from documentation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4d809d9 and 9483d3b.

⛔ Files ignored due to path filters (1)

• src_c/doc/sdl2_controller_doc.h is excluded by !src_c/doc/*

📒 Files selected for processing (1)

• docs/reST/ref/sdl2_controller.rst (0 hunks)

💤 Files with no reviewable changes (1)

• docs/reST/ref/sdl2_controller.rst

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

• Provide your own instructions using the high_level_summary_instructions setting.
• Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
• Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

1. 📝 Description — Summarize the main change in 50–60 words, explaining what was done.
2. 📓 References — List relevant issues, discussions, documentation, or related PRs.
3. 📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.
4. 📊 Contributor Summary — Include a Markdown table showing contributions:
   | Contributor | Lines Added | Lines Removed | Files Changed |
5. ✔️ Additional Notes — Add any extra reviewer context.
   Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[oddbookworm]

I would like to get @zoldalma999 to chime in here. Is a better alternative adding this function into the new controller module?