From 5bdba1aeae948bd2ebb0a59d0e297a99b12db0b1 Mon Sep 17 00:00:00 2001

From: =?UTF-8?q?Jaakko=20Kera=CC=88nen?= jaakko.keranen@iki.fi

Date: Mon, 1 Nov 2021 19:07:45 +0200

Subject: [PATCH 1/1] Typo

README.md | 4 ++--

1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md

index bfcb4cd..eb87b9e 100644

--- a/README.md

+++ b/README.md

@@ -39,7 +39,7 @@ Using these, one can create and destroy instances of the type without having acc

"method_Type" naming convention

-Global identifiers and functions generally use the following naming convention:

+Global identifiers generally use the following naming convention:

• iType: the prefix i is used for the global namespace: all types and verb-like macros.

• Impl_Type: the private implementation of Type, i.e., a struct containing the member variables.

@@ -51,7 +51,7 @@ Global identifiers and functions generally use the following naming convention:

C doesn't have namespaces, so some kind of a prefix is required to avoid conflicts. i was chosen to be visually as small as possible, so it doesn't interfere readability as much as a longer or large capital letter prefix.

-Usually type names precede a method name in C APIs, but I find it makes reading the code more difficult. The beginnings of words is important as the eye is naturally drawn to them, so we want to have actually meaning information at the beginning of each line of code.

+Usually type names precede a method name in C APIs, but I find it makes reading the code more difficult. The beginnings of words are important as the eye is naturally drawn to them, so we want to have actually meaning information at the beginning of each line of code.

Having the type name be the last part of an identifier is also advantegous because thanks to its location, it becomes naturally associated with the instance pointer, i.e., the first parameter. This enables chaining method calls without losing track of types.

--

2.25.1