Improve the relationships documentation in views.api.php

Created on 21 February 2024, 9 months ago
Updated 8 March 2024, 9 months ago

Problem/Motivation

Views Add Handler is not very informative when Help is missing, yet views.api.php does not make it clear that relationships can contain help.

Steps to reproduce

  1. Follow the documentation in views.api.php to add a relationship between custom external database tables that all have a structure like
  2. Person table with id
  3. Multiple tables with relationship set as person_id
  4. Quickly get lost as to which relationship to add to create the desired joins

Proposed resolution

Update the documentation to show that help can be used

Remaining tasks

Provide MR

User interface changes

None

API changes

None

Data model changes

None

Release notes snippet

Updated views.api.php to show that help text can be provided for relationships

πŸ“Œ Task
Status

Fixed

Version

11.0 πŸ”₯

Component
ViewsΒ  β†’

Last updated about 5 hours ago

Created by

πŸ‡¬πŸ‡§United Kingdom scott_euser

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

Production build 0.71.5 2024