docs icon indicating copy to clipboard operation
docs copied to clipboard

Incorrect Use of "Checkout" vs. "Check Out" in Documentation

Open cmaliwal opened this issue 1 year ago • 1 comments

Prerequisites

  • [X] I checked the existing issues and made sure there are no similar bug reports

Category

Incorrect or missing Content

Expected Behavior / Content

We should use "check out" when referring to the verb (e.g., "Please check out this feature"). We should use "checkout" when referring to the noun (e.g., "Proceed to checkout").

Observed Behavior / Content

Most instances in our documentation incorrectly use "checkout" instead of "check out" when referring to the verb.

To Reproduce

No response

Environment Details (Optional)

No response

Failure Logs (Optional)

No response

Additional Information (Optional)

No response

cmaliwal avatar Aug 08 '24 20:08 cmaliwal

Checkout, while a noun of referring to git/code is acceptable even if used as a verb due to the reference to a known act. Checkout in a phrase like “checkout this really cool x” is a verb, and should be check out, however in relation to a git repository or code base, I think 'checkout' is the right use of the word.

This is kinda like the word "hoover", while a noun, it's also a verb depending on it's use. I could be wrong of course, but I need examples of where this is an issue in your eyes 👍

devjsc avatar Aug 09 '24 08:08 devjsc