obsproject / obs-websocket

Remote-control of OBS Studio through WebSocket
GNU General Public License v2.0
3.89k stars 707 forks source link

Docs request: Clarify deprecation alternative #1020

Closed Rosuav closed 2 years ago

Rosuav commented 2 years ago

Feature Request Type

Other

Feature Request Type (Other)

Explain what SHOULD be done instead of what's discouraged

Requested Feature

In GetGroupSceneItemList, the use of groups is discouraged. It would be helpful to say what is encouraged instead - for instance, is the use of a scene as a source in another scene as broken as groups, or a non-broken alternative?

Requested Feature Usage Scenario

Someone comes to the docs to look at ways to manipulate groups, sees a scary warning, and currently has no idea what to do instead. A brief docs mention would be an authoritative recommendation, guiding the user to a safer alternative.

tt2468 commented 2 years ago

Clarified via docs commit

Rosuav commented 2 years ago

Thanks! Appreciate it!