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

Standardize function names #213

Open
lhearachel opened this issue Jun 4, 2024 · 0 comments
Open

Standardize function names #213

lhearachel opened this issue Jun 4, 2024 · 0 comments

Comments

@lhearachel
Copy link
Collaborator

lhearachel commented Jun 4, 2024

Per discussion from Discord, we will be updating functions within the repository to follow a standard naming scheme for consistency. The new naming scheme for functions in the repository is: [<Module>_]<Imperative><Object>

Some common examples:

// Store the memory address of struct-member `bar` from `foo` in `out`.
void Foo_GetBarPtr(Foo *foo, int *out);

// Return the value of struct-member `bar`.
int Foo_GetBar(Foo *foo);

// Return the value of BOOL-typed struct-member `bar`.
BOOL Foo_IsBar(Foo *foo);

// Set the value of struct-member `bar` to `in`.
void Foo_SetBar(Foo *foo, int in);

// Loop through the elements of `foo->barArray` and return the first
// to match a condition.
int Foo_FindFirstBar(Foo *foo);
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant