Translate README to English, remove brmangue-specific bug narrative - #5
Merged
Conversation
profsergiocosta
commented
Sep 4, 2026
profsergiocosta
commented
Contributor
- Removed sections that only made sense with examples/brmangue_validation/ present: the open disk+Flood+Mangrove divergence problem, TerraME validation walkthrough, and the 'why brmangue tests live in examples/' rationale (moot now that the directory is gone)
- Generalized 'halo=1 insufficient for FloodModel' into a domain-agnostic finding about halo depth = dependency chain depth, not shift radius, keeping the core lesson and real numbers without naming BR-MANGUE model classes
- Generalized the boundary_value=0 finding to a generic domain example instead of BR-MANGUE's SOLO_CANAL_FLUVIAL specifics
- Trimmed equivalence-tests and disk-layer sections to only the tests that still exist in this repo
- Verified: all runnable code blocks in the new README behave identically (same pass/fail pattern) to the original Portuguese version -- no new bugs introduced by the rewrite
- Full pytest suite still 79 passed, 1 skipped
- Removed sections that only made sense with examples/brmangue_validation/ present: the open disk+Flood+Mangrove divergence problem, TerraME validation walkthrough, and the 'why brmangue tests live in examples/' rationale (moot now that the directory is gone) - Generalized 'halo=1 insufficient for FloodModel' into a domain-agnostic finding about halo depth = dependency chain depth, not shift radius, keeping the core lesson and real numbers without naming BR-MANGUE model classes - Generalized the boundary_value=0 finding to a generic domain example instead of BR-MANGUE's SOLO_CANAL_FLUVIAL specifics - Trimmed equivalence-tests and disk-layer sections to only the tests that still exist in this repo - Verified: all runnable code blocks in the new README behave identically (same pass/fail pattern) to the original Portuguese version -- no new bugs introduced by the rewrite - Full pytest suite still 79 passed, 1 skipped
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.