docs(geochron): real rendered screenshots for every visible setting - #376
Open
ChuckBuilds wants to merge 1 commit into
Open
docs(geochron): real rendered screenshots for every visible setting#376ChuckBuilds wants to merge 1 commit into
ChuckBuilds wants to merge 1 commit into
Conversation
Documentation only; no behaviour change. All 24 settings documented, with an image for each one that has a visible effect. The hero image was an uploaded GitHub attachment on an external URL. It is now a committed render that regenerates from the plugin and is verified by --check, so it cannot quietly stop matching what the plugin draws. Two comparisons are worth the space. The seasonal set renders the terminator at both equinoxes and both solstices at 12:00 UTC on the real dates, from the same solar code that runs on the panel -- equinox terminators run pole to pole, the June solstice leaves the Arctic in daylight, December does the same for the Antarctic. And the map-centring set shows what map_center_longitude does on a square panel, which is the setting most likely to be reached for and hardest to describe in words. Both enums were hash-checked rather than assumed: all four graticule_step_deg values and both clock_format values render distinctly. Existing content is kept -- how it works, the aspect-ratio layout table, the vendored Natural Earth notes -- and the default-cities table regains the latitude and longitude alongside the timezone strings, since copying those is the reason to look at it. Not fixed here, filed as #375: the plugin overflows a 128x32 panel by 2px and its goldens drift on six of eight sizes. Both are pre-existing on main (identical figures with these changes stashed). The overflow is a hard harness failure rather than drift and is worth fixing on its own terms; I have left the goldens alone for the same reason as #371, that regenerating from this machine could bake in local rendering behaviour. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Contributor
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Team Run ID: Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Up to standards ✅🟢 Issues
|
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
1 participant
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.
Eleventh plugin in the README pass. Documentation only; no behaviour change.
What changed
The old README was one of the better ones already — accurate, well structured — so this is images and gaps rather than a rewrite. All 24 settings documented, with a comparison image for each one that has a visible effect.
The hero image was an uploaded GitHub attachment on an external URL. It's now a committed render that regenerates from the plugin and is verified by
--check, so it can't quietly stop matching what the plugin draws.Two comparisons worth the space
Seasons. The terminator at both equinoxes and both solstices, 12:00 UTC on the real dates, from the same solar code that runs on the panel. Equinox terminators run pole to pole; June leaves the Arctic in daylight; December does the same for the Antarctic. It doubles as a visual check that the solar maths is right.
Map centring. What
map_center_longitudedoes on a square panel — the setting most likely to be reached for and hardest to describe in prose.Both enums hash-checked
No repeat of the font problem here.
Two pre-existing failures, filed as #375
check_plugin.pyfails on this plugin, and both are pre-existing onmain— identical figures with my changes stashed:The overflow is the one I'd look at first: it draws 2px past the right edge of a 128-wide panel, which is a hard failure rather than a comparison, and on a chained display that content lands on the next panel. 128×32 uses the wide-sidebar layout and 256×32 (also wide sidebar) doesn't overflow, so the sidebar looks mis-sized at the narrower width.
I left the goldens alone for the same reason as #371 — I can't tell from here whether they're stale or correctly catching a regression, and regenerating from this machine risks baking in local rendering behaviour.
Credit where due
This plugin's
render_preview.pyis the pattern I wish tide-display had used: it importsgeochron_renderer, the same modulemanager.pydraws with, so its previews cannot disagree with the plugin. I've said so in the README's Development section as an example to copy.Verification
render_docs_assets.py --plugin geochron --check— images match🤖 Generated with Claude Code