remote/datasette
1
0
Fork 0
mirror of https://github.com/simonw/datasette.git synced 2026-07-13 19:14:35 +02:00
Code Issues Projects Releases Packages Wiki Activity

Clarify docs for descriptions in metadata

Browse source
This commit is contained in:
Garth Kidd 2023-07-08 11:28:35 +10:00
commit 3b787aae74
1 changed files with 9 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

9
docs/metadata.rst
View file

@ -78,6 +78,15 @@ The three visible metadata fields you can apply to everything, specific database
For each of these you can provide just the ``*_url`` field and Datasette will treat that as the default link label text and display the URL directly on the page.
.. _metadata_description:
Descriptions
------------
You can apply a **description** or **description_html** field to the index page, specific databases or specific tables. If both are present, the HTML description wins.
Unlike the metadata fields above, descriptions do not cascade from the index to databases or from databases to their columns.
.. _metadata_column_descriptions:
Column descriptions