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

C API needs casing fixed for function names #547

Open
capnkenny opened this issue Jan 3, 2023 · 3 comments
Open

C API needs casing fixed for function names #547

capnkenny opened this issue Jan 3, 2023 · 3 comments
Labels
bug Something isn't working good first issue Good for newcomers help wanted Extra attention is needed miscellaneous Smaller odd job tasks that don't fit into a specific category/

Comments

@capnkenny
Copy link
Member

capnkenny commented Jan 3, 2023

Describe the issue:
C API currently has non-matching function name casing and should be updated so that the function names match our current code style.

The C API should match NovelRT's API and function names should be in PascalCase.

Please provide the steps to reproduce if possible:
N/A - code styling issue

Additional context:
Reference to code style issue where casing is incorrect.

@capnkenny capnkenny added bug Something isn't working help wanted Extra attention is needed good first issue Good for newcomers miscellaneous Smaller odd job tasks that don't fit into a specific category/ labels Jan 3, 2023
@bjauny
Copy link
Contributor

bjauny commented Oct 21, 2023

Hi there,

If I get it right, you need all the functions in the headers listed after the "#if defined(NOVELRT_C_API)" clause to be renamed?

For example: Nrt_getLastError to NrtGetLastError, or Nrt_AudioService_Create to NrtAudioServiceCreate?

Or does the Nrt_ prefix needs to be kept?

@RubyNova
Copy link
Member

Hi,

Nrt_getLastError would become Nrt_GetLastError.

@bjauny
Copy link
Contributor

bjauny commented Oct 22, 2023

Thanks!
As an additional input, should I create multiple pull requests as I rename sets of functions? For example, renaming the NrtErrorHandling API gives me 46 files modified for 362 changes on the project. What would be the easiest to review for you?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working good first issue Good for newcomers help wanted Extra attention is needed miscellaneous Smaller odd job tasks that don't fit into a specific category/
Projects
None yet
Development

No branches or pull requests

3 participants