Skip to content

Enhance Engine Class Readability and Maintainability #72

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

Merged
merged 3 commits into from
May 31, 2024

Conversation

thomaskleiven
Copy link
Collaborator

@thomaskleiven thomaskleiven commented May 31, 2024

Closes #71

I've made an attempt on improving the readability and maintainability of the Engine class. This PR includes a refactor, with an option to split the logic into smaller files. The refactoring only involves lifting and shifting inline functions into .inl and .h files; no logic or functionality has been changed.

If the current structure works better for you, feel free to dismiss this PR.

@thomaskleiven thomaskleiven self-assigned this May 31, 2024
@thomaskleiven thomaskleiven marked this pull request as draft May 31, 2024 14:39
@thomaskleiven thomaskleiven changed the title lift and shift inline function to inl files Enhance Engine Class Readability and Maintainability May 31, 2024
@cyrusbehr
Copy link
Owner

I had a look over, it looks good. Is this ready to merge? Or you are still working on it (marked as draft)?

@thomaskleiven thomaskleiven marked this pull request as ready for review May 31, 2024 16:09
@thomaskleiven thomaskleiven requested a review from cyrusbehr May 31, 2024 16:10
Copy link
Owner

@cyrusbehr cyrusbehr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please write a note in this section of the Readme with an overview the the new project structure, to give guidance to a novice on which files they should refer to to view the interfaces, etc

image

Copy link
Owner

@cyrusbehr cyrusbehr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. Great work!

@cyrusbehr cyrusbehr merged commit 845cf0d into cyrusbehr:main May 31, 2024
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

Successfully merging this pull request may close these issues.

Separate Inline Functions From Declaration Files
2 participants