Update guidelines on tables; add captions to tables #10296
Conversation
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
- Explain how to use a reST `table` directive to add captions to simple tables and grid tables - Explain how to add captions to reST "list tables" - Explain how to create cross references to tables with `:ref:` and `:numref:` roles - Explain how to customize the `:numref:` link text
The "Overview of the Print Layout" details the tools in several menus. Most tables detailing those tools do not have a caption, with one exception. This update removes the unnecessary caption from that table.
This commit uses explicit reST table directives to move captions into tables, rather than writing the caption as a separate paragraph after the table.
Some of the documentation already uses reST `csv-table` directives to create complicated tables. This commit adds a reference to "CSV Tables" to the dcoumentation guidelines.
The updated table had a header, but the grid table did not mark the row as a header. This update marks the header, leaving the table text unchanged.
This commit uses reST `table` directives to "attach" captions to tables in the "Gentle Introduction to GIS." The original captions followed the tables as separate paragraphs. This update moves those captions into the tables. In places, the caption is shortened, and text from the original caption is retained as a separate paragraph. Cross references to tables are also updated to use Sphinx `:numref:` roles.
elijahgreenstein
changed the title
DelazJ
added
Guidelines
backport release_3.44
DelazJ
reviewed
Oct 7, 2025
There was a problem hiding this comment.
Thanks @elijahgreenstein for this harmonization.
See my feedback below.
Only explain the `:numref:` role. Remove explanations of the `:ref:` role.
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.
Goal: Fix #10282
:ref: and:numref:roles for cross references_table_(follows the pattern for figures)In the process, modified a few additional tables to (1) specify header rows and (2) remove one unnecessary caption (inconsistent with other tables on the page).
Ticket(s): #