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

Streamline the conventions used for various APIs (which are currently fairly inconsistent) #323

Open
rdw-software opened this issue Oct 8, 2023 · 1 comment

Comments

@rdw-software
Copy link
Member

rdw-software commented Oct 8, 2023

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, and camelCase.

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:

  • The vfs library is also referred to as LUAZIP (which is the signature header) and zipApp (Python lingo)
@rdw-software 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
@rdw-software rdw-software moved this to The time is nigh (Planning) in Evo.lua: Timeline Oct 8, 2023
@rdw-software
Copy link
Member Author

May also want to consider some of the points mentioned here: https://google.github.io/styleguide/cppguide.html

Not everything applies, but having a more consistent guideline than what currently exists would certainly help.

@rdw-software 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 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: The time is nigh (Planning)
Development

No branches or pull requests

1 participant