Fix documentation and data integrity safeguards - #25
Merged
Conversation
🧪 R Equivalence Validation ResultsSee full validation report in artifacts. |
dshkol
marked this pull request as ready for review
July 10, 2026 02:29
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.
Summary
get_census()cache keys canonical, schema-versioned, and sensitive to geometry resolution and label modeCensusAPIErrorsubclasses across public API entry points and addNetworkErrorfor exhausted connection failuresRoot causes
Generated notebooks were being discovered as the canonical Sphinx documents, which left the gallery's RST reference targets unresolved. The geographic example also used NumPy without importing it.
The census cache key omitted output-affecting options, public wrappers replaced resilience exceptions with generic
RuntimeErrorinstances, and geometry/vector responses fell back to positional alignment when identifiers were unavailable.Impact
Gallery thumbnails now open their example pages and the geographic plots execute correctly. Cached high-resolution and label-mode variants cannot collide. Callers can catch the documented API exception hierarchy, and ambiguous geography/vector combinations fail explicitly instead of returning potentially misaligned census data.
Validation
black --checkpassedflake8checks passedgit diff --checkpassedCloses #24