-
Notifications
You must be signed in to change notification settings - Fork 8
Style convention #283
Copy link
Copy link
Open
Labels
HousecleaningStuff related with style conventions, good practices, clean code, repo organization, etc.Stuff related with style conventions, good practices, clean code, repo organization, etc.
Metadata
Metadata
Assignees
Labels
HousecleaningStuff related with style conventions, good practices, clean code, repo organization, etc.Stuff related with style conventions, good practices, clean code, repo organization, etc.
Here we try to establish some conventions. Feel free to propose your own!
typerather thanTYPE.type(edge_t)rather thantype (edge_t)._t. Example: prefertype(cell_t)rather thantype(cell)._m. Example: prefermodule mesh_mrather thanmodule mesh.end ifrather thanendif.sizeas variable name.(and the interior of functions or during variable declaration. Example preferinteger(kindrather thaninteger ( kindparametersmust be named with upper cased letters. Example: preferRKINDtorkind.