Move table configuration docs from metadata.rst to configuration.rst#2668
Merged
Move table configuration docs from metadata.rst to configuration.rst#2668
Conversation
Move table configuration documentation (sort, sort_desc, size, sortable_columns, label_column, hidden, facets, facet_size, fts_table, fts_pk, searchmode, columns, column_types) from metadata.rst into a new "Table configuration" section in configuration.rst, which is the canonical reference for datasette.yaml. metadata.rst now has a brief section pointing to the new location. Cross-references in facets.rst, full_text_search.rst, internals.rst, json_api.rst, and pages.rst updated to point to new anchors. Old anchor names preserved as aliases so existing links continue to work. https://claude.ai/code/session_01UqboRB5Wt52BKPhxexUBEn
Owner
Author
|
Here's the new section: https://datasette--2668.org.readthedocs.build/en/2668/configuration.html#table-configuration |
Also removed note about backwards compatibility.
Owner
Author
|
Each heading now has only one label using the table_configuration_* naming convention. Updated all :ref: links in changelog.rst to use the new anchor names. https://claude.ai/code/session_01UqboRB5Wt52BKPhxexUBEn
The auto-detection checks for: (1) a single unique text column, (2) a column named "name" or "title", (3) a two-column table with one primary key column - not just the two-column case. https://claude.ai/code/session_01UqboRB5Wt52BKPhxexUBEn
These table configuration examples were showing metadata.yaml/json tabs but should show datasette.yaml/json since they are configuration, not metadata. Also updated prose references from "metadata" to "configuration" in facets.rst. https://claude.ai/code/session_01UqboRB5Wt52BKPhxexUBEn
Column descriptions are metadata (stored via set_column_metadata), not table configuration. Moved the columns section back to metadata.rst and removed it from configuration.rst. Also added a :ref: link from the column_types docs to the register_column_types plugin hook. https://claude.ai/code/session_01UqboRB5Wt52BKPhxexUBEn
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2668 +/- ##
=======================================
Coverage 90.56% 90.56%
=======================================
Files 55 55
Lines 8308 8308
=======================================
Hits 7524 7524
Misses 784 784 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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
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.
This PR reorganizes the documentation to consolidate table-level configuration options into a dedicated section in the configuration reference, improving documentation structure and maintainability.
Summary
Table configuration documentation has been moved from
docs/metadata.rstto a new "Table configuration" section indocs/configuration.rst. This change reflects the fact that these options are now primarily configured viadatasette.yamlwhile maintaining backwards compatibility with metadata files.Key Changes
New section in configuration.rst: Added comprehensive "Table configuration" section documenting all table-level configuration options:
sort/sort_desc- default sort ordersize- rows per pagesortable_columns- which columns allow sortinglabel_column- foreign key display labelshidden- hide tables from listingfacets/facet_size- facet configurationfts_table/fts_pk/searchmode- full-text searchcolumns- column descriptionscolumn_types- semantic column type assignmentsUpdated metadata.rst: Replaced detailed table configuration documentation with a brief reference pointing to the configuration.rst section, noting backwards compatibility with metadata files
Updated cross-references: Fixed documentation links throughout:
docs/facets.rst- updated reference to table configurationdocs/full_text_search.rst- updated reference to table configurationdocs/json_api.rst- updated label_column referencedocs/pages.rst- updated hidden tables referencedocs/internals.rst- updated label_column referenceImplementation Details
datasette.yamlor metadata files, withdatasette.yamltaking priorityhttps://claude.ai/code/session_01UqboRB5Wt52BKPhxexUBEn
📚 Documentation preview 📚: https://datasette--2668.org.readthedocs.build/en/2668/