-
Notifications
You must be signed in to change notification settings - Fork 145
docs: Fix spelling errors in GeneralsMD/Code/GameEngine comments #2146
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
base: main
Are you sure you want to change the base?
docs: Fix spelling errors in GeneralsMD/Code/GameEngine comments #2146
Conversation
|
| Filename | Overview |
|---|---|
| GeneralsMD/Code/GameEngine/Source/GameLogic/AI/AIDock.cpp | Corrected 18 instances of "extention" to "extension" in comments |
| GeneralsMD/Code/GameEngine/Source/GameLogic/Object/Object.cpp | Fixed multiple spelling errors: "doens't" → "doesn't", "implemtation" → "implementation", "maintenence" → "maintenance", "verbage" → "verbiage", "thise" → "these" |
| GeneralsMD/Code/GameEngine/Include/GameClient/GameWindow.h | Corrected spelling in comments: "propogated" → "propagated", "addtional" → "additional", "sytem" → "system", "heirarchy" → "hierarchy", "piont" → "point", "chilc" → "child", "paramater" → "parameter", "reguardless" → "regardless" |
| GeneralsMD/Code/GameEngine/Source/GameClient/GUI/GameWindowManager.cpp | Fixed spelling errors: "statis" → "status", "propogate" → "propagate", "debuggin" → "debugging", "widnow" → "window", "compaired" → "compared", "intialize" → "initialize", "legths" → "lengths" |
| GeneralsMD/Code/GameEngine/Source/GameLogic/System/GameLogic.cpp | Corrected spelling: "neccessary" → "necessary", "allocater" → "allocator", "provied" → "provided", "indentifier" → "identifier" |
| GeneralsMD/Code/GameEngine/Source/GameLogic/Object/Update/AIUpdate/RailroadGuideAIUpdate.cpp | Fixed spelling: "wont" → "won't", "buliding" → "building", "reseting" → "resetting", "carraige" → "carriage" (2 instances) |
Sequence Diagram
sequenceDiagram
participant Dev as Developer
participant IDE as IDE/Editor
participant Files as Comment Text
participant Review as Code Review
Dev->>IDE: Identify spelling errors in comments
IDE->>Files: Scan 105 files across codebase
Note over Files: Core/GameEngine/*<br/>Generals/Code/GameEngine/*<br/>GeneralsMD/Code/GameEngine/*
Files->>Dev: Found spelling errors:<br/>- impelmentation → implementation<br/>- extention → extension<br/>- doens't → doesn't<br/>- and many more...
Dev->>Files: Apply corrections to comments
loop For each file
Files->>Files: Replace misspelled word<br/>with correct spelling
end
Files->>Review: 186 lines changed (only comments)
Review->>Review: Verify corrections are accurate
Review->>Dev: Approve changes (documentation quality improved)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
105 files reviewed, 1 comment
Generals/Code/GameEngine/Source/GameClient/GUI/ControlBar/ControlBarCommand.cpp
Outdated
Show resolved
Hide resolved
Generals/Code/GameEngine/Source/GameClient/GUI/ControlBar/ControlBarCommand.cpp
Outdated
Show resolved
Hide resolved
Generals/Code/GameEngine/Source/GameClient/GUI/GameWindowManager.cpp
Outdated
Show resolved
Hide resolved
GeneralsMD/Code/GameEngine/Source/GameClient/GUI/GUICallbacks/Menus/KeyboardOptionsMenu.cpp
Outdated
Show resolved
Hide resolved
GeneralsMD/Code/GameEngine/Source/GameClient/GUI/GUICallbacks/Menus/KeyboardOptionsMenu.cpp
Outdated
Show resolved
Hide resolved
GeneralsMD/Code/GameEngine/Source/GameLogic/Object/Behavior/BunkerBusterBehavior.cpp
Outdated
Show resolved
Hide resolved
|
|
||
| /// A convenience function to reveal shroud at some location | ||
| // Queueing does not give you control of the timestamp to enforce the queue. I own the delay, you don't. | ||
| // Queuing does not give you control of the timestamp to enforce the queue. I own the delay, you don't. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Both spellings are technically correct.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Whichever doesn't make Xezon's IDE complain then? :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Although not exclusively, queuing aligns more to American English, while queueing is used more in British English.
We use American English as that was the language that EA used. So I would say this change is correct.
GeneralsMD/Code/GameEngine/Source/GameLogic/Object/SpecialPower/SpecialPowerModule.cpp
Outdated
Show resolved
Hide resolved
|
It looks like not all Stubbjax comments are addressed. |
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
…rolBarCommand.cpp Co-authored-by: Stubbjax <stubbjax02@hotmail.com>
…er.cpp Co-authored-by: Stubbjax <stubbjax02@hotmail.com>
…rolBarCommand.cpp Co-authored-by: Stubbjax <stubbjax02@hotmail.com>
Co-authored-by: Stubbjax <stubbjax02@hotmail.com>
…Menus/KeyboardOptionsMenu.cpp Co-authored-by: Stubbjax <stubbjax02@hotmail.com>
Co-authored-by: Stubbjax <stubbjax02@hotmail.com>
…Menus/KeyboardOptionsMenu.cpp Co-authored-by: Stubbjax <stubbjax02@hotmail.com>
…nkerBusterBehavior.cpp Co-authored-by: Stubbjax <stubbjax02@hotmail.com>
Co-authored-by: Stubbjax <stubbjax02@hotmail.com>
0be45b4 to
64fc1d0
Compare
addressed and rebased main |
| TheRadar->removeObject( this ); | ||
|
|
||
| // Just in case I have been sporting one of thise fancy Terrain Decals, | ||
| // Just in case I have been sporting one of these fancy Terrain Decals, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Super nit: I imagine this was a those due to the proximity of i and o.
| // Just in case I have been sporting one of these fancy Terrain Decals, | |
| // Just in case I have been sporting one of those fancy Terrain Decals, |
| // | ||
| // since we're assuming all inventory exit commands appear in a continuous order, | ||
| // we need to also need to keep track of what is the last valid inventory commadn index | ||
| // we need to also need to keep track of what is the last valid inventory command index |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove duplicate instance of 'need to'.
Fix spelling errors in code comments.