aip-dev / google.aip.dev

API Improvement Proposals. https://aip.dev/
Other
1.07k stars 488 forks source link

AIP-192: ensure Trademarked names do not appear in examples #1097

Open dandhlee opened 1 year ago

dandhlee commented 1 year ago

We should make sure that Trademarked names don't appear in the documentation as an example by mistake.

For example, if there is a company called foo.xyz, this is fine:

and for any other relevant documentation that is within reasonable bounds for Trademarked names. However, this may happen and should be prevented & explicitly called out:

which is not a proper use for Trademarked names.

toumorokoshi commented 1 year ago

Hello! do you have a specific example?

Feel free to send a PR to fix any incorrect uses of trademark.

dandhlee commented 1 year ago

This doesn't pertain to a specific example of a trademark, but a general approach to ensure that all trademarks are used appropriately and not mistakenly used as an example.

I'd like to ensure that folks are aware of this and that we can point to this guide should this be brought up in reviews - this can be hard to enforce programmatically, but as a starter having this explicitly documented would be great!