docs: rename the stockpiles tag to stockpile - #5917
Merged
Merged
Conversation
The tag shares its name with the stockpiles plugin, so opening help for the tool in gui/launcher lists all tools carrying the tag instead of showing the plugin's entry and related tools. Fixes DFHack#5843
Tool docs live in both dfhack and the scripts submodule, but tags are registered only from dfhack's Tags.rst. A tag rename lands in each repo separately while the submodule pin lags, so a build can see :tags: that no registered domain exists for. Skip unregistered tags instead of failing with a KeyError; they render as plain text and still get logged.
ab9rf
approved these changes
Sep 17, 2026
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
2 participants
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
Fixes #5843
The
stockpilestag shares its name with thestockpilesplugin. Whengui/launcheris opened for that tool (e.g. via the ? button on the plugin's window), the first word resolves as a tag before an entry, so the autocomplete switches to "Tagged tools" and lists everything carrying the tag instead of showing the plugin's entry and similar tools.Renames the tag to
stockpilein the tag list and in the plugin docs here. Companion scripts-side PR updates the tags in the script docs: DFHack/scripts#1623Also makes
tool_docs.pytolerate tool docs that reference tags not registered inTags.rst. The scripts submodule pin lags behind changes in either repo, so during a tag rename one side always sees an unregistered tag; unregistered tags are now skipped and rendered as plain text instead of failing the build with a KeyError. That keeps CI green on both PRs independently of merge order.Testing
stockpile, the unregisteredstockpilestag is skipped and logged, and thestockpilesplugin entry no longer collides with a tag.