Consider adding descriptions to config schema

Created on 17 November 2014, about 10 years ago
Updated 22 March 2023, almost 2 years ago

This was brought up in #2144413-182: Config translation does not support text elements with a format β†’ .

Problem/Motivation

Data definitions support descriptions but we do not use descriptions in our configuration schema in core. This would be helpful concretely for auto-generated configuration forms and also generally for making bring configuration schema more inline with field definitions of content entities.

Because config schema arrays get turned into DataDefinition objects they already support setting a description key, it is just that we do not do that anywhere in core yet.

Proposed resolution

Add descriptions to configuration schemas.

Please note (again) that this is not an API change and not even an API addition. The API is already there. Therefore we could also decide to do this step by step or something.

Remaining tasks

User interface changes

API changes

πŸ“Œ Task
Status

Active

Version

9.5

Component
ConfigurationΒ  β†’

Last updated 3 days ago

Created by

πŸ‡©πŸ‡ͺGermany tstoeckler Essen, Germany

Live updates comments and jobs are added and updated live.
  • D8MI

    (Drupal 8 Multilingual Initiative) is the tag used by the multilingual initiative to mark core issues (and some contributed module issues). For versions other than Drupal 8, use the i18n (Internationalization) tag on issues which involve or affect multilingual / multinational support. That is preferred over Translation.

  • Usability

    Makes Drupal easier to use. Preferred over UX, D7UX, etc.

Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Production build 0.71.5 2024