33 feature request code hygiene #39
Conversation
There was a problem hiding this comment.
Pull request overview
This PR implements code hygiene improvements across the codebase, including typo corrections, improved naming conventions, and enhanced code readability. The changes include fixing spelling errors (e.g., "Foulder" to "Folder", "sucsess" to "success"), improving variable naming conventions (e.g., PascalCase to camelCase), removing unused variables, and updating documentation comments for clarity.
Key Changes
- Fixed numerous spelling errors in variable names, comments, and documentation
- Improved variable naming conventions (camelCase for local variables, proper capitalization)
- Removed unused code and environment variable loading logic from tests
- Enhanced API documentation with clearer descriptions and consistent formatting
Reviewed changes
Copilot reviewed 10 out of 11 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| test/GTestMain.cpp | Simplified test setup by hardcoding test values instead of loading from environment files, removed unused variables |
| test/AyonCppApiTestsMain.cpp | Improved naming conventions and modernized loop syntax with range-based for loops |
| src/AyonCppApi/perfPrinter.h | Fixed spelling errors ("Foder" to "Footer") and corrected time calculation logic |
| src/AyonCppApi/devMacros.h | Added defensive check for JTRACE macro definition |
| src/AyonCppApi/Instrumentor.h | Improved code formatting and fixed variable naming inconsistencies |
| src/AyonCppApi/CMakeLists.txt | Corrected filename from "appDataFoulder.h" to "appDataFolder.h" |
| src/AyonCppApi/AyonCppApi.h | Fixed spelling errors throughout documentation and variable names, improved documentation clarity |
| src/AyonCppApi/AyonCppApi.cpp | Extensive spelling corrections, improved variable naming, enhanced error messages, fixed loop bounds issue |
| ext/ayon-cpp-dev-tools | Updated subproject commit reference |
| AyonBuild.py | Added default variable initialization stage |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
src/AyonCppApi/AyonCppApi.cpp
Outdated
| #endif | ||
|
|
||
| // TODO implement the better Crash handler | ||
| // TODO implement the better Crash hanlder |
There was a problem hiding this comment.
Typo in TODO comment: 'hanlder' should be 'handler'.
| // TODO implement the better Crash hanlder | |
| // TODO implement the better Crash handler |
src/AyonCppApi/AyonCppApi.h
Outdated
| // --- Runtime Dep Vars | ||
|
|
||
| // Async Grp Generation Varibles | ||
| // Async Grp Generation Varaibles |
There was a problem hiding this comment.
Typo in comment: 'Varaibles' should be 'Variables'.
src/AyonCppApi/AyonCppApi.cpp
Outdated
| std::string payload = R"({{"resolveRoots": true,"uris": [)"; | ||
|
|
||
| for (int i = 0; i <= int(uriVec.size()); i++) { | ||
| for (size_t i = 0; i <= uriVec.size(); i++) { |
There was a problem hiding this comment.
Off-by-one error: loop condition uses <= which will cause out-of-bounds access. Should be < instead of <=.
| for (size_t i = 0; i <= uriVec.size(); i++) { | |
| for (size_t i = 0; i < uriVec.size(); i++) { |
| Project.Func("", AyonCppApiPrj.setVar, "AYON_CPP_API_ENALBE_GBENCH", "OFF"), | ||
| Project.Func("", AyonCppApiPrj.setVar, "AYON_CPP_API_ENALBE_GTEST", "OFF"), |
There was a problem hiding this comment.
Typo in variable names: 'ENALBE' should be 'ENABLE' in both GBENCH and GTEST variable names.
src/AyonCppApi/AyonCppApi.h
Outdated
| * @brief this function loads all needed varible into the class \n | ||
| * this will allso be called by the constructor |
There was a problem hiding this comment.
Multiple spelling errors in documentation: 'varible' should be 'variable' and 'allso' should be 'also'.
| * @brief this function loads all needed varible into the class \n | |
| * this will allso be called by the constructor | |
| * @brief this function loads all needed variables into the class \n | |
| * this will also be called by the constructor |
Changelog Description
Code hygiene. Typo fixes, better code readability, fixing naming conventions, ...
Additional review information
Tested together with this resolver's PR - working in Maya2026 with local and also with secured server.
Testing notes:
...