Document the bugs found and how they were fixed - #11
Merged
Conversation
Adds NEWS.md, which the package did not have, and a Troubleshooting section to the README. NEWS.md leads with the layer-ordering bug, because that one can affect results already in hand rather than only future runs. It says what was affected, how to recognise it in existing output - a column whose values are in the wrong range for its name - and that the cached NetCDF files were always correct, so only naming was wrong and a re-fetch is enough. It also records the cache move, which is the one change that silently alters behaviour on an existing machine. The README section is keyed to the literal error text, so someone can paste a message and find it. That includes two messages from versions before today's fixes, since anyone running an older install will hit those rather than the current ones. The version heading is 0.0.0.9000 rather than "(development version)". R's NEWS.md parser wants a version it can parse, and the usethis-style heading produces "No news entries found" from R CMD check. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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
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.
Adds
NEWS.md, which the package did not have, and a Troubleshooting section to the README.NEWS.md
Leads with the layer-ordering bug, because that one can affect results already in hand rather than only future runs. It records:
SSTcolumn;Also records the two other fixes, and the cache move — the one change that silently alters behaviour on an existing machine, with the one-liner to point at the old directory.
README troubleshooting
Keyed to the literal error text, so a message can be pasted and found. Covers the client-not-found case, the different-datasets refusal (which is expected behaviour, not a fault), missing variables, depth ranges, and download failures.
It also covers two messages from before today's fixes, since anyone on an older install will hit those rather than the current ones — including "values in the wrong range for their column name", which has no error message at all.
One detail worth noting
The version heading is
# datamatch 0.0.0.9000, not# datamatch (development version). R'sNEWS.mdparser wants a version it can parse; the usethis-style heading produces aNo news entries foundNOTE fromR CMD check. Verified both ways — with the usethis heading the check was1 NOTE, and with the version number it is clean.Verification
R CMD check— Status: OK.tools:::.build_news_db_from_package_NEWS_md()parses the file: 3 entries under version0.0.0.9000, categories Bug fixes / Breaking changes / New features.🤖 Generated with Claude Code