From: Arnaud Giersch <arnaud.giersch@univ-fcomte.fr>
Date: Fri, 23 Oct 2020 13:28:39 +0000 (+0200)
Subject: Update README.coding to match the current practice for getters/setters.
X-Git-Tag: v3.26~255
X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/b6ee4aa41147b87590035acbc013cf666f0c158f

Update README.coding to match the current practice for getters/setters.
---

diff --git a/README.coding b/README.coding
index 44414b90f2..7417d89d34 100644
--- a/README.coding
+++ b/README.coding
@@ -35,11 +35,11 @@ SimGrid4 will follow the these rules:
     - Example: src/kernel/activity/Activity.cpp
                include/simgrid/activity/Activity.hpp
   C
-  - Field getters are named sg_object_field() eg sg_link_name()
-    Field setters are named sg_object_field_set() eg sg_link_data_set()
+  - Field getters are named sg_object_get_field() e.g. sg_link_get_name()
+    Field setters are named sg_object_set_field() e.g. sg_link_set_data()
   - variables and functions are in snake_case()
-  - typedefs do not hide the pointers, ie * must be explicit
-    char * sg_host_get_name(sg_host_t * host);
+  - typedefs do not hide the pointers, i.e. * must be explicit
+    char* sg_host_get_name(sg_host_t* host);
   
 
 This is different from the old convention (described below), that