Skip to content

docs: reconcile release quality notes with current behavior - #2193

Closed
giswqs wants to merge 1 commit into
mainfrom
docs/release-quality-2026-11-15
Closed

giswqs wants to merge 1 commit into
mainfrom
docs/release-quality-2026-11-15

Conversation

@giswqs

@giswqs giswqs commented Nov 15, 2026

Copy link
Copy Markdown
Member

Summary

Reconcile the guide with existing reader and tool behavior: CityGML truncation boundaries, named-class raster padding, spreadsheet sampling and budgets, missing-date groups, generated geocoding field names, Clip sliver notices, archive reload validation, and Python multi-layer return/name semantics. Add a direct tile-reload anchor, name the Messages section consistently, and remove the completed terrain refinement roadmap item.

The projected-column preference paragraph accompanies #2190; merge this PR after that fix.

Testing

Documentation diff checks and Python syntax parsing passed. No runtime logic changes. Long workspace checks continue in CI; local validation uses GDAL 3.13.3.

UI evidence

No visible UI change.

Deferred review points

@coderabbitai

coderabbitai Bot commented Nov 15, 2026

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 6 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used all 8 included reviews currently available.

Learn how review limits work.

Review configuration:

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 669557a9-2588-4e21-8f7a-9ce203657bf9
Commits

Reviewing files that changed from the base of the PR and between ce40749 and 99dd133.

Files selected for processing: 9

  • ROADMAP.md
  • apps/rustgis-python/python/rustgis/__init__.py
  • docs/user-guide/analysis.md
  • docs/user-guide/data-formats.md
  • docs/user-guide/data.md
  • docs/user-guide/editing.md
  • docs/user-guide/index.md
  • docs/user-guide/maps.md
  • docs/user-guide/sharing.md
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

Share

@giswqs

giswqs commented Nov 15, 2026

Copy link
Copy Markdown
Member Author

Superseded by the combined release-quality PR #2196 so these related fixes can be reviewed together.

@giswqs giswqs closed this Nov 15, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Code review

No bugs, security issues, or performance problems found. The PR changes only documentation and one Python docstring, and I checked the documented behaviour against the code.

Bugs: None found.

Security: None found.

Performance: None found.

Quality:

  • docs/user-guide/data.md (the projected-column paragraph, about line 147) and docs/user-guide/data-formats.md (the Shapefile row's notice about nan/inf, about line 108) break lines well past the ~100-column wrap used elsewhere. Reflow nit; high confidence it is cosmetic. Left for the release quality pass.
  • apps/rustgis-python/python/rustgis/__init__.py (the add_data name docstring) says a name "names only the first layer added". data.md says it goes to the first map layer, and a standalone table gets it only when the file has no map layer. The engine's doc comment at crates/engine/src/cmd/layer.rs:2199 matches the Python wording, so the gap is in data.md's wording, not the code. Low confidence that anyone will be misled.

AGENTS.md: No violations; the changes are docs and a docstring only.

Notes for the author (not findings):

Checked and consistent with the code:

  • Picture messages: "pictures aren't supported" (crates/ui-egui/src/popupmedia.rs).
  • Clip sliver ratio of 1e-6 and the notice text (crates/analysis/src/tools.rs).
  • Delimited-text column sampling of 1,000 rows, and spreadsheets scanning every row (io.rs, sheets.rs).
  • match_status_ / match_status__ uniqueness (crates/engine/src/tests.rs).
  • Raster outside-value rule for named classes (crates/analysis/src/warp.rs).
  • PMTiles tile-range and zero-length-section validation (crates/tiles/src/pmtiles.rs).
  • Shapefile non-finite values becoming empty (crates/data/src/source/shp.rs).
  • CityGML truncation notice (crates/data/src/citygml.rs).
  • The #diagnostics anchor has no remaining references, and the new #reloading-a-local-tile-archive-desktop anchor matches its heading.

Earlier concerns: there are no prior review threads, so none were left alone.

Change size

Compared with main (merge base ce40749 to PR head 99dd133). Sizes are file sizes in bytes, not line counts.

Measure Value
Files changed 9 (0 added, 9 modified, 0 removed, 0 renamed)
Size before 571.6 KB
Size after 572.8 KB
Total size change +1.2 KB
Path Before After Change
docs/user-guide/maps.md 55.5 KB 55.9 KB +374 B
docs/user-guide/analysis.md 154.4 KB 154.6 KB +258 B
docs/user-guide/data.md 126.8 KB 127.0 KB +237 B
docs/user-guide/data-formats.md 93.1 KB 93.3 KB +211 B
apps/rustgis-python/python/rustgis/init.py 36.0 KB 36.2 KB +180 B
ROADMAP.md 21.1 KB 21.0 KB -109 B
docs/user-guide/editing.md 30.9 KB 30.9 KB +40 B
docs/user-guide/index.md 41.5 KB 41.5 KB +36 B
docs/user-guide/sharing.md 12.4 KB 12.4 KB +7 B

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant