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

Cleanup semantic differences between older and newer files #173

Open
WSSDude opened this issue Jan 19, 2025 · 1 comment
Open

Cleanup semantic differences between older and newer files #173

WSSDude opened this issue Jan 19, 2025 · 1 comment
Labels
enhancement New feature or request

Comments

@WSSDude
Copy link
Contributor

WSSDude commented Jan 19, 2025

Noticed some inconsistent things, so far 3 apart from formatting (which should get resolved by #172) and 1 potential code quality issue.

  • unks seems to have a mix of lowercase in name and arrays, uppercase in comments in some older code and everything uppercase in newer code
  • in some places, doxygen comments seem to be used but majority of comments currently around the code seem to be just regular ones
    • probably would be good to swap to doxygen comments, but this would need some discussion and probably a lot of changes
  • CONTRIBUTING.md/Declare a new member section mentions removal of explicit alignment which may be harmful (but in majority of cases wasnt yet)
    • I believe there should be some audit made to see what used to have some alignment specified and doesnt now, and discuss what to do with items that miss it now, as at least according to psiberx, they may not matter much for a lot of cases. Could be though because some other member enforces the alignment on including class (hence why some audit may be a good idea)
  • constness should be revisited throughout the project, newer stuff tries to be const-correct where possible but some older code is not
@WSSDude
Copy link
Contributor Author

WSSDude commented Jan 19, 2025

I suppose I should have marked it as a "feature" even though this is more of a code quality "enhancement", as it seems it shares the "enhancement" label (and I can't add it now after making the issue).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants