You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
There are multiple layers of abstraction that might warrant different conventions. But there's also a lot of "winging it", third-party libraries doing their own thing, and at least two or so ways of error handling used (failure returns, errors, and possibly others).
All in all, it's a bit messy and I've always been bothered by having to accomodate snake_case, PascalCase, and camelCase.
Before an organized cleanup can take place, however, a few common denominators need to be found that work for all layers:
Error handling: C++ exceptions (bad/slow), failure returns (idiomatic), errors (easier to test/intuitive)
Capitalization rules: C uses snake_case, C++ a mix of snake_case for C APIs, Pascal and even camelCase, Lua all three...
TBD: What other issues and inconsistencies are there? Should review the entire codebase and jot down all potential issues here.
Potential inconsistencies in the Lua portions of the codebase:
The vfs library is also referred to as LUAZIP (which is the signature header) and zipApp (Python lingo)
The text was updated successfully, but these errors were encountered:
rdw-software
changed the title
Streamline the conventions used for various APIs (because it's currently fairly arbitrary, i.e., a bit of a mess)
Streamline the conventions used for various APIs (which are currently fairly arbitrary)
Oct 8, 2023
Not everything applies, but having a more consistent guideline than what currently exists would certainly help.
rdw-software
changed the title
Streamline the conventions used for various APIs (which are currently fairly arbitrary)
Streamline the conventions used for various APIs (which are currently fairly inconsisten)
Feb 10, 2024
rdw-software
changed the title
Streamline the conventions used for various APIs (which are currently fairly inconsisten)
Streamline the conventions used for various APIs (which are currently fairly inconsistent)
Feb 10, 2024
See https://evo-lua.github.io/docs/references/code-conventions for an example of the complexity this brings (very unintuitive)...
There are multiple layers of abstraction that might warrant different conventions. But there's also a lot of "winging it", third-party libraries doing their own thing, and at least two or so ways of error handling used (failure returns, errors, and possibly others).
All in all, it's a bit messy and I've always been bothered by having to accomodate
snake_case
,PascalCase
, andcamelCase
.Before an organized cleanup can take place, however, a few common denominators need to be found that work for all layers:
TBD: What other issues and inconsistencies are there? Should review the entire codebase and jot down all potential issues here.
Potential inconsistencies in the Lua portions of the codebase:
vfs
library is also referred to asLUAZIP
(which is the signature header) andzipApp
(Python lingo)The text was updated successfully, but these errors were encountered: