Skip to content

docs: Fix spelling errors in code comments#2630

Merged
pcarruscag merged 2 commits intosu2code:developfrom
shbhmexe:docs/fix-spelling-errors-comments
Nov 26, 2025
Merged

docs: Fix spelling errors in code comments#2630
pcarruscag merged 2 commits intosu2code:developfrom
shbhmexe:docs/fix-spelling-errors-comments

Conversation

@shbhmexe
Copy link

Proposed Changes

This PR fixes spelling errors in code comments to improve documentation clarity and professionalism.

Files Modified:

  • Common/src/geometry/CPhysicalGeometry.cpp - Fixed 5 typos
  • Common/include/geometry/primal_grid/CPrimalGrid.hpp - Fixed 1 typo
  • SU2_CFD/src/variables/CMeshVariable.cpp - Fixed 1 typo
  • SU2_CFD/src/solvers/CGradientSmoothingSolver.cpp - Fixed 1 typo

Corrections Made:

Typo Correction File Line
genral general CPhysicalGeometry.cpp 4778
caount count CPhysicalGeometry.cpp 4795
Initilize Initialize CPhysicalGeometry.cpp 4781
Initalize Initialize CMeshVariable.cpp 37
initalize initialize CGradientSmoothingSolver.cpp 96
surronding surrounding CPhysicalGeometry.cpp 4669
surronding surrounding CPrimalGrid.hpp 52
Localice Localize CPhysicalGeometry.cpp 4645

Rationale:

  • Ensures correct spelling in all code documentation
  • Improves code professionalism and readability
  • No behavior or API changes
  • Comment-only modifications with zero functional impact

Related Work

None. This is a minimal documentation/spelling fix isolated to code comments.

PR Checklist

  • I am submitting my contribution to the develop branch.
  • My contribution generates no new compiler warnings (header-only comment change).
  • My contribution is commented and consistent with SU2 style (https://su2code.github.io/docs_v7/Style-Guide/).
  • I used the pre-commit hook to prevent dirty commits and used pre-commit run --all to format old commits.
  • I have updated appropriate documentation if necessary (not applicable).

Impact

Functionality: unchanged.

Performance/Memory: unchanged.

CI: should have no effect on ASAN/TSAN builds and regression/unit tests because no logic changed.


Confirmation

This change does NOT break any existing functionality

This is a documentation-only change that corrects spelling errors in 8 code comments across 4 files. The fixes:

  • Do not modify any executable code
  • Do not change any function signatures or APIs
  • Do not affect build process or compilation
  • Do not require any test updates
  • Have zero impact on runtime behavior

All changes are comment-only modifications that maintain the repository's current behavior while improving documentation quality and professionalism.


Summary Statistics

Metric Value
Files Changed 4
Typos Fixed 8
Lines Modified 8
Type Documentation/Comments only
Functional Impact None

Fixed multiple spelling errors in comments across the codebase:
- Changed "genral" to "general" in CPhysicalGeometry.cpp
- Changed "caount" to "count" in CPhysicalGeometry.cpp
- Changed "Initilize/initalize" to "Initialize/initialize" (3 occurrences)
- Changed "surronding" to "surrounding" (2 occurrences)
- Changed "Localice" to "Localize" in CPhysicalGeometry.cpp
These documentation-only changes improve code clarity and professionalism
with no impact on functionality.

Signed-off-by:  shbhmexe <shubhushukla586@gmail.com>
@shbhmexe
Copy link
Author

/label changelog:fix

@bigfooted bigfooted changed the base branch from master to develop November 26, 2025 12:52
@pcarruscag pcarruscag merged commit 911d1f3 into su2code:develop Nov 26, 2025
37 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants