Apple warns developers API tweaks will flow from style guide changes that remove non-inclusive language

New rules define allow lists and deny lists, send masters and slaves to the Trash

45 Reg comments Got Tips?

Apple has issued a new style guide that deprecates what it calls “non-inclusive language”, and has started to apply it to Xcode, platform APIs, documentation, and open source projects.

The changes will have real impact, because Apple has told developers to watch out for API changes resulting from the changes.

“Developer APIs with exclusionary terms will be deprecated as we introduce replacements across internal codebases, public APIs, and open source projects, such as WebKit and Swift,” the company said on Thursday. “We encourage you to closely monitor deprecation warnings across your codebases and to proactively move to the latest APIs available in the platform SDKs.”

Among the changes are an instruction not to use “whitelist” or “blacklist”. In their place Apple suggests: “use an alternative that’s appropriate to the context, such as deny list/allow list or unapproved list/approved list.”

Master and slave are out, too. “Instead, use an alternative that’s appropriate to the context, such as primary/secondary, primary/replica, main/secondary, or host/client,” Apple advises.

But Apple has also made exceptions for the abovementioned terms when they are “used in code you’re documenting and the code can’t be changed”.

Developers in that situation have been told “it’s OK to show a code sample to make it clear what users need to enter, but you should still use alternative terms in the documentation.”

There’s no new guidance on terms that refer to mental health, an issue Google took up with its decision not to use phrases like “sanity check” in its documentation.

The guide now also suggest that “black” be capitalised when used as an adjective “when referring to ethnicity or cultural identity.” Apple’s example of correct use is: “Learn about Black leaders who have shaped the world.”

Apple is far from alone in making this sort of change: Google, Linux, Splunk and GitHub have all made similar changes. ®

SUBSCRIBE TO OUR WEEKLY TECH NEWSLETTER


Biting the hand that feeds IT © 1998–2020