Add text field to paste filters for documentation

Created on 21 October 2024, about 1 month ago

Problem/Motivation

It's not always clear what a particular filter was intended to do, especially for more complex filters and those created by other developers. Something as simple as a space at the end of a filter, or replacement, could easily go unnoticed. And for many of us, it doesn't take long to forget exactly why we included a particular filter.

Proposed resolution

Add a text field to each filter for notes, so developers and site builders can optionally document the intent of their filters.

Remaining tasks

  1. Decide on label for new text field (Notes, Description, Intent, ???).
  2. Update module to include new text field.
  3. Add test coverage for new text field.

User interface changes

A third field, labeled "Notes" (or something along those lines), will appear with each filter in the paste filter configuration.

API changes

None.

Data model changes

None.

Feature request
Status

Active

Version

1.0

Component

Miscellaneous

Created by

🇺🇸United States jstoller

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

Comments & Activities

  • Issue created by @jstoller
  • 🇨🇦Canada star-szr

    Thanks for the feature request @jstoller! I like the idea and don’t have any immediate concerns, although it will make the form vertically larger. I’m not sure when I can work on this feature in the near future but I’m happy to review patches/MRs and help it along with reviews and such.

Production build 0.71.5 2024