Repository navigation
Conversation
HexDecimal
left a comment
There was a problem hiding this comment.
The results of compute_fov with an out-of-bounds pov are both undocumented and deprecated. If necessary, the recommend changes are informed by the deprecation warning itself which is to convert its warning into an error. Defining the previously undefined behavior in the way this pull request does ironically adds technical debt to the codebase, but that can be acceptable if the change is more intentional and the documentation is updated to match.
The lack of context awareness around this PR implies a poor use of automation tools. Ideally these would be used to help code match the documentation or fix major bugs, this is neither case. Raising an issue may have been preferable to a pull request.
Non-English commit messages are tricky to review. Most Git tools do not have auto-translations. I'm not quite sure what to do about this yet.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #199 +/- ##
==========================================
+ Coverage 86.24% 86.26% +0.01%
==========================================
Files 29 29
Lines 7679 7680 +1
==========================================
+ Hits 6623 6625 +2
+ Misses 1056 1055 -1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
HexDecimal
left a comment
There was a problem hiding this comment.
These changes are good. Everything I'd want updated were updated.
|
Ignore the current CI build failures. They are not relevant to the current PR. |
Initialize the temporary FOV map buffer to zero so an out-of-bounds point of view cannot return uninitialized visibility flags.
compute_fov()currently warns about an out-of-bounds point of view and continues. libtcod then returns an error without filling the FOV cells. Since the wrapper allocates those cells withnp.empty, the result can contain stale visibility data. Zero-initialization preserves the existing warning behavior and returns an all-false mask in this case.The regression tests cover all four map boundaries with a poisoned allocation so the failure is deterministic. All four fail before the fix. After the fix, these tests and the existing map tests pass (9 passed). Ruff reports no issues on the changed source and test files.
Validation used the tcod 21.2.2 wheel with only
tcod/map.pyreplaced by the updated file. Before the change, that file was byte-for-byte identical to the current source. A full source build and rendering tests were not run.