Skip to content

Remove unavailable and deprecated name_forindex function from documentation #3647

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Remove unavailable and deprecated name_forindex function from documentation #3647

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0bac1e8
Remove unavailable and deprecated name_forindex function
BatteRaquette581 Nov 20, 2025
9483d3b
Remove unavailable and deprecated name_forindex function
BatteRaquette581 Nov 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 0 additions & 10 deletions docs/reST/ref/sdl2_controller.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,16 +102,6 @@ events related to controllers.

.. ## pygame._sdl2.controller.is_controller ##

.. function:: name_forindex

| :sl:`Get the name of the controller`
| :sg:`name_forindex(index) -> name or None`

Returns the name of controller, or None if there's no name or the
index is invalid.

.. ## pygame._sdl2.controller.name_forindex ##

.. class:: Controller

| :sl:`Create a new Controller object.`
Expand Down
1 change: 0 additions & 1 deletion src_c/doc/sdl2_controller_doc.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
#define DOC_SDL2_CONTROLLER_GETEVENTSTATE "get_eventstate() -> bool\nGets the current state of events related to controllers"
#define DOC_SDL2_CONTROLLER_GETCOUNT "get_count() -> int\nGet the number of joysticks connected"
#define DOC_SDL2_CONTROLLER_ISCONTROLLER "is_controller(index) -> bool\nCheck if the given joystick is supported by the game controller interface"
#define DOC_SDL2_CONTROLLER_NAMEFORINDEX "name_forindex(index) -> name or None\nGet the name of the controller"
#define DOC_SDL2_CONTROLLER_CONTROLLER "Controller(index) -> Controller\nCreate a new Controller object."
#define DOC_SDL2_CONTROLLER_CONTROLLER_INIT "init() -> None\nInitialize the Controller"
#define DOC_SDL2_CONTROLLER_CONTROLLER_QUIT "quit() -> None\nuninitialize the Controller"
Expand Down
Loading