Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixing critical unwatchable catastrophic grammatical mistake #381

Closed
wants to merge 1 commit into from

Conversation

PoulDev
Copy link

@PoulDev PoulDev commented May 11, 2024

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

In the vast expanse of code, nestled within its intricate lines, lies a curious anomaly - a grammatical faux pas that beckons correction. Like a misplaced comma or a dangling participle, it stands out amidst the syntax, silently pleading for attention. The culprit? A function named "cleanup."

At first glance, one might not bat an eye at such a seemingly innocuous choice of nomenclature. However, upon closer inspection, the error reveals itself. "Cleanup" as a verb is not a single entity but rather two separate words - "clean" and "up." Thus, the function's name violates the conventions of grammatical correctness.

In the realm of coding, where precision reigns supreme and clarity is paramount, such oversights can have repercussions. A misnamed function might sow confusion among developers, leading to misunderstandings and inefficiencies in the codebase. It's akin to a misspelled variable or a misplaced comment - a small oversight with potentially significant consequences.

To remedy this linguistic misdemeanor, a simple adjustment is required. The function should be christened "cleanUp," adhering to the established rules of grammar and ensuring consistency within the codebase. By embracing camelCase convention and joining "clean" and "up" into a unified whole, the function's purpose becomes instantly clear to anyone who encounters it.

Yet, this error serves as a reminder of the complexities inherent in both language and code. Just as words must follow grammatical rules to convey meaning effectively, so too must code adhere to syntax and conventions to fulfill its purpose. In the intricate dance between human language and programming languages, attention to detail is paramount.

But even amidst the rigidity of syntax and the strictures of convention, there is room for creativity and expression. Just as a poet selects words with care to craft a verse, so too must a programmer choose names for functions and variables with precision and foresight. Each line of code tells a story, and the names within it are the characters that bring that story to life.

So, let us not dismiss the significance of a single misplaced letter or a misaligned word. In the grand tapestry of code, every detail matters, and every choice reverberates throughout the system. And as we strive for perfection in our craft, let us remember that even the humblest function name holds the potential to shape the destiny of our creations.
@loricso
Copy link

loricso commented May 11, 2024

"I agree"
~ Marcus Aurelius

@Kissaki
Copy link
Contributor

Kissaki commented May 12, 2024

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.

@PoulDev PoulDev closed this by deleting the head repository May 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants