applitools / eyes.sdk.python

Applitools Eyes Python SDK
Other
17 stars 17 forks source link

eyes_robotframework: Documentation: Use "Ultrafast Grid" instead of UFG #381

Closed emanlove closed 3 years ago

emanlove commented 3 years ago

It is recommended that documentation uses the full term instead of acronyms if your target audience is learning the subject matter presented. I came across the acronym "UFG" first in the keyword tags and unfamiliar with this acronym searched the applitools doc. There is no usage of "UFG" in the docs. Searching the main applitools.com website there I found some references to "UFG" and, although still somewhat obscure, I was able to realize this was something called "Ultrafast Grid". Then I was able to search some more to see what Ultrafast grid was.

So in general its best not to use acronyms in documentation.

emanlove commented 3 years ago

I should add I see no problems using UFG internally in the code nor external in for example the setting web_ufg. This recommendation is more for documentation then code or settings.

eirenik0 commented 3 years ago

Hi @emanlove ! Thanks for this advice too!