News:

  • August 12, 2026, 03:18:54 AM

Login with username, password and session length

Author Topic: Feature Request: UDT Descriptions  (Read 7811 times)

RBPLC

  • Hero Member
  • *****
  • Posts: 586
Feature Request: UDT Descriptions
« on: February 22, 2023, 01:38:03 PM »
Ability to add a "universal" description when creating UDTs.

franji1

  • Bit Weenie
  • Host Moderator
  • Hero Member
  • *****
  • Posts: 3842
    • Host Engineering
Re: Feature Request: UDT Descriptions
« Reply #1 on: February 23, 2023, 09:53:57 AM »
Are you looking to document individual fields (e.g. .Temperature with Description "Degrees F"), or just at the actual UDT level?

I could see Extra Info and/or Description.  Very helpful to document ALL .Temperature fields as "Degrees F" when you have a recipe block of 100 of them - just do it one place.  Also, you could OVERRIDE the "default" UDT level Description/Extra Info in the Documentation Editor for an ACTUAL ELEMENT of a RecipeStruct Temperature field, e.g. assign "Actual Temp Deg F" for Recipe0.Temperature Description, where Recipe0 is the "current" recipe (Recipe1 thru Recipe99 are selectable recipes).

RBPLC

  • Hero Member
  • *****
  • Posts: 586
Re: Feature Request: UDT Descriptions
« Reply #2 on: February 23, 2023, 11:26:27 AM »
Are you looking to document individual fields (e.g. .Temperature with Description "Degrees F"), or just at the actual UDT level?

I could see Extra Info and/or Description.  Very helpful to document ALL .Temperature fields as "Degrees F" when you have a recipe block of 100 of them - just do it one place.  Also, you could OVERRIDE the "default" UDT level Description/Extra Info in the Documentation Editor for an ACTUAL ELEMENT of a RecipeStruct Temperature field, e.g. assign "Actual Temp Deg F" for Recipe0.Temperature Description, where Recipe0 is the "current" recipe (Recipe1 thru Recipe99 are selectable recipes).

Looking to document all .Fields at the UDT level. Enter the description once and have it propagate to all instances of that field.