Cleanup: Initial untangling of town_cmd.cpp #11389
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation / Problem
While working on the Scenario Editor features suggested in #11377, I discovered that
town_cmd.cpp
is a hot mess.Before I can even consider refactoring town growth code, the entire file needs some cleanup.
Description
This is a first pass at cleaning up the file. Each task is a separate commit for ease of review. I plan to rebase when merging to keep the history clear.
Yes, my last documentation commit got a bit out of hand; adding missing doxygen turned into fixing grammar and then fixing punctuation... 馃槵 I hope it's not too hard to review. 馃槂
Limitations
Checklist for review
Some things are not automated, and forgotten often. This list is a reminder for the reviewers.