Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify docs for descriptions in metadata #2096

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/metadata.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down