search

free-audio / clap

Audio Plugin API
https://cleveraudio.org/
MIT License
1.76k stars 97 forks source link

Document more precise use of param name vs module #263

Closed SamWindell closed 1 year ago

SamWindell commented 1 year ago

Following the discussion: https://github.com/free-audio/clap/discussions/248#discussion-4683110

There was a slight consenus towards ensuring that the name field does not also contain the text of the module. Instead, the host should somehow display module alongside name if name alone would be too vague.

This PR suggests putting these rules into the header comments. It's separate from my other PR as it might be more controversial.

CLAassistant commented 1 year ago

CLA assistant check
All committers have signed the CLA.

abique commented 1 year ago

Please add changelog entries.

abique commented 1 year ago

Please add changelog entries.

Never mind, I'll do it.

abique commented 1 year ago

Thank you for both pull requests 👍