Optional return description

Problem/Motivation

With a good self-descriptive API name and a return type, there could be cases where putting the description of a return type would not make sense. For example:

  /**
   * Determines if series template should be created.
   *
   * @param array $settings
   *   Entity bundle settings.
   *
   * @return bool
   *   TRUE if yes, otherwise FALSE.
   */
  public function shouldCreateSeriesTemplate(array $settings): bool;

Here the the API name itself tells what it would return. Description TRUE if yes, otherwise FALSE. can be skipped - and the purpose of the output could still be understood.

Proposed resolution

Make description optional.

Remaining tasks

N/A

User interface changes

N/A

API changes

N/A

Data model changes

N/A

Release notes snippet

N/A