search

libsdl-org / sdlwiki

This is the raw contents of SDL's wiki. You can edit this through GitHub or at https://wiki.libsdl.org/ now!
https://wiki.libsdl.org/
79 stars 32 forks source link

SDL3/SDL_EnumerateProperties: Fix small typo #571

Closed SDLWikiBot closed 1 month ago

SDLWikiBot commented 1 month ago

This edit was made by @Ribiveer.

Live page is here: https://wiki.libsdl.org/SDL3/SDL_EnumerateProperties

If this user should be blocked from further edits, an admin should go to https://wiki.libsdl.org/Ribiveer/block If this user should be trusted to make direct pushes to main, without a pull request, an admin should go to https://wiki.libsdl.org/Ribiveer/trust

Ribiveer commented 1 month ago

I don't know how to create a pull request with multiple commits from the wiki. It's not my intention to spam this repo with tiny commits!

slouken commented 1 month ago

No, please feel free to spam with multiple commits! The system is designed for us to be able to easily pick and choose what we accept, and it's no problem to see them individually.

slouken commented 1 month ago

I'm not sure your change is correct here. The enumerate function enumerates properties on a set of properties. I know that sounds redundant, but that's what it's doing.

icculus commented 1 month ago

"Enumerate the list of properties available from an SDL_PropertiesID"?

slouken commented 1 month ago

"Enumerate the list of properties available from an SDL_PropertiesID"?

I like it!

slouken commented 1 month ago

Or "Enumerate the properties contained in an SDL_PropertiesID"?

Ribiveer commented 1 month ago

I hadn't been following this conversation, but I just came back because I realised my change was incorrect. So it's good that it's already been discussed.

Ribiveer commented 1 month ago

My proposed change would be "Enumerate the properties contained in a property set."

My two cents on the naming of SDL_PropertiesID and the functions containing the name "Properties", is that they are quite unintuitively named. When talking about "properties", it's ambiguous between multiple properties, a property set or multiple sets. Since they're called property sets elsewhere, I think renaming them to SDL_PropertySetID with functions like SDL_CreatePropertySet would help clear this up some more, and make the language surrounding it less confusing. This was also where I think my mistake came from when suggesting this change.

slouken commented 1 month ago

I went with your wording, thanks! Can you open an SDL issue for confusion around SDL_PropertiesID? I'll add it to the ABI milestone for consideration.

Ribiveer commented 1 month ago

Done! It can be found here: https://github.com/libsdl-org/SDL/issues/10241