Overv / VulkanTutorial

Tutorial for the Vulkan graphics and compute API
https://vulkan-tutorial.com
Creative Commons Attribution Share Alike 4.0 International
3.2k stars 527 forks source link

Fixing critical unwatchable catastrophic grammatical mistake #381

Closed PoulDev closed 6 months ago

PoulDev commented 6 months ago

Good Evening @elmarco @shish @Kissaki @usagi @ElieDeBrauwer, I was reading your tutorials when, suddenly, I encountered a unacceptable grammatical mistake, but let's start from the beginning.

Your code follows the camelCase style for functions, which means that every new word start with a capital letter, except for the first one. Here's an example:

void addUser
(
    void
)
{
    return;
}

But there's a function, a function named cleanup, that got my attention.

I have an hypothesis: cleanup is wrong!

After a very heated argument with a friend ( not anymore ) of mine, he put a rock on the argument by saying the following words, and I quote:

"In the lexicon of language, we adhere to the nuanced intricacies of expression; hence, we utilize "clean up" rather than "cleanup" to convey the depth of our actions."

Here's a graphical representation:

cartoon-two-people-arguing-illustration-71754529

But WHY?

Why Marcus Aurelius said to use clean up and not cleanup? There's a crucial rule in grammar: cleanup is written without any space ONLY if it's used as a noun or an adjective.

"Cleanup (one word) is a noun or an adjective. To wit: The cleanup after the rowdy festival took days to complete." "Clean up (two words) is a verb. Also to wit: You’ll need a broom, dust pan, and mop to clean up the kitchen floor. "


here's some examples This function cleans up memory wait, I'm cleaning up my code

So, in code/01_instance_creation.cpp I suggest to change the function cleanup in cleanUp.

This being said, have a nice day sir.

Credits: Me & Marcus Aurelius

loricso commented 6 months ago

"I agree" ~ Marcus Aurelius

Kissaki commented 6 months ago

Good morning @PoulDev

First, to ensure future communication remains understandable, I want to point you to your opening of "Good Evening", where you upper-cased evening instead of using the correct English grammar of lower-casing the noun.

Given your extensive knowledge and care for grammar, your making this mistake is both surprising and inexcusable.

But more gravely, you seem to misattribute who created this tutorial and who can change it. I don't know what steps you took to use correct attribution and highlighting, but it seems to be shallow at best. Consequently, the whole suggestion has to be questioned. I would suggest you revoke it and first seek to ensure its thorough correctness.