roc icon indicating copy to clipboard operation
roc copied to clipboard

Reword "host" to "platform" in all app-developer-facing text

Open kili-ilo opened this issue 3 years ago • 3 comments

I just learned about the Roc executable flag --precompiled-host, and it's great! However, it's confusingly named to an app developer. Roc app developer know about Roc platforms, but "host" is either meaningless, synonymous for platform, synonymous for platform language, or synonymous for server/device. Therefore, can we please protect app developers against any host confusion by only referring to platforms?

Where else does "host" appear?

  • [ ] --precompiled-host

kili-ilo avatar Jul 25 '22 03:07 kili-ilo

@JanCVanB Hey I want to work on this issue.

Can you please guide me specifically in which files I need to change "host" to "platform" ?

vedant-z avatar Aug 15 '22 05:08 vedant-z

I haven't done a file search, and I don't know how many phrases/variables containing "host" (other than --precompiled-host) could be improved with a rename. However, I recommend starting by editing any occurrences of precompiled-host (there may be other casings, such as precompiledHost, I don't know) and then expanding your search to analyze occurrences of host/Host.

kili-ilo avatar Aug 15 '22 17:08 kili-ilo

@bhansconnect do you have any tips for what other variables/names should be changed?

kili-ilo avatar Aug 15 '22 17:08 kili-ilo

I've started working on this renaming work myself, and I've realized that it's trickier that initially expected. Due to the dual meanings of both "host" (sometimes a language, sometimes a device) and "platform" (sometimes a Roc codebase, sometimes a CPU architecture), I've started a discussion in Zulip for feedback on various phrases & contexts.

kili-ilo avatar Sep 06 '22 04:09 kili-ilo

@vedant-z Well, that PR is definitely bigger than what I initially expected for this Issue! 😆

kili-ilo avatar Sep 07 '22 01:09 kili-ilo