Repository navigation
docs(analysis): drop the built-in tool count - #1044
Conversation
The sentence above the tool table counted the built-in tools by hand. The count goes stale (main says 25 while TOOLS registers 26), and every pull request that adds a tool edits the same line, so tool pull requests open at the same time conflict with each other. The table lists the tools and `gp.tools` lists the available ones, so the sentence no longer counts them.
|
No actionable comments were generated in the recent review.
 |
| Layer / File(s) | Summary |
|---|---|
Update tool count description docs/user-guide/analysis.md |
The description removes the fixed count of 25 built-in tools and retains the note about GeoLibre and plugin tools. |
Priority:
Estimated code review effort: 1 (Trivial) | ~2 minutes
Change: Other · Severity of issue fixed: Low
Possibly related PRs
- opengeos/RustGIS#984: Adds
nearto the built-in analysis tools and changes the same tool-count documentation. - opengeos/RustGIS#1003: Adds Feature Vertices To Points to the built-in tool table and changes the count from 24 to 25.
- opengeos/RustGIS#1006: Adds
vectorToPmtilesto the built-in tool table, changing the tool set represented by the fixed count.
Suggested reviewers: mavrick-f
Merge Risk: 
d2161
-
The guide avoids a manually maintained tool count while preserving the availability description. No actionable merge-blocking risk remains.
Pre-merge checks: 
-
Check name Status Explanation Title check The title clearly and concisely describes the documentation change: removing the manually maintained built-in tool count. Description check The description includes the required Summary, Testing, and Related issue sections. It explains the stale count, the replacement text, verification steps, and why UI evidence is not needed for this do… Docstring Coverage No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within survi… Linked Issues check Check skipped because no linked issues were found for this pull request. Out of Scope Changes check Check skipped because no linked issues were found for this pull request. Full details: Description check
-
Explanation
The description includes the required Summary, Testing, and Related issue sections. It explains the stale count, the replacement text, verification steps, and why UI evidence is not needed for this documentation-only change.
Full details: Docstring Coverage
-
Explanation
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)
-
Finishing Touches
-
🧪 Generate unit tests (beta)
-
- Create a new PR
-
- 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.
A rabbit reads the guide at dawn,
The fixed tool count is now withdrawn.
GeoLibre joins when it is there,
Plugin tools can join the pair.
The page stays clear, the count stays gone.
Comment @coderabbitai help to get the list of available commands.
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| map was clicked is copied as the command that buffered it, with the point. | ||
|
|
||
| There are 25 built-in tools; GeoLibre and plugin tools join them when available. | ||
| These are the built-in tools; GeoLibre and plugin tools join them when available. |
There was a problem hiding this comment.
Nit (confidence: low-medium). "These" has no clear antecedent here: the paragraph above ends on copying a buffer as a command, so a reader may take "these" to mean that. The old "There are 25 built-in tools" had no such problem. Naming the table directly avoids both the count and the ambiguity:
| These are the built-in tools; GeoLibre and plugin tools join them when available. | |
| The built-in tools are listed below; GeoLibre and plugin tools join them when available. |
Code reviewBugs: None found. The one-line change is accurate: Security: None. Docs-only change. Performance: None. Quality:
AGENTS.md: No violations. The PR touches no code, interface text, assets or dependencies. Checked: Change sizeCompared: the whole PR against main (merge base f200e88 to PR head d216121).
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
📖 Docs preview
GitHub Pages takes a minute or two to publish a new commit. |
Summary
The sentence above the tool table in
docs/user-guide/analysis.mdcounts the built-in tools by hand ("There are 25 built-in tools"). It is already stale on main:TOOLSincrates/analysis/src/tools.rsregisters 26 tools and the table has 26 rows. Each pull request that adds a tool has to change that number, and whichever one merges later has to merge main again and redo it (#1003 needed a follow-up commit after Near and Vector to PMTiles landed). The sentence now reads "These are the built-in tools; …": the table lists them andgp.toolslists the available ones.Testing
Docs only, one sentence. No code, test or xtask reads it, and
git grepfinds no other copy. pre-commit passes, and the branch merges cleanly into main and together with #1003.Related issue
None. #1003 leaves the line as main has it, so the two don't conflict.
Summary by CodeRabbit