Added Description Field Info for Custom Functions and Actions #319
Conversation
|
|
| @@ -243,6 +243,16 @@ Here's an example of an Action that returns a _nullable_ integer. | |||
|
|
|||
|  | |||
|
|
|||
| ## Adding Description | |||
There was a problem hiding this comment.
| ## Adding Description | |
| ## Descriptions |
| @@ -243,6 +243,16 @@ Here's an example of an Action that returns a _nullable_ integer. | |||
|
|
|||
|  | |||
|
|
|||
| ## Adding Description | |||
|
|
|||
| You can add a [**Description**](../../intro/ff-ui/resource-hierarchy.md#resource-description) note on Custom Functions and Custom Actions to briefly explain their purpose, usage, or important details. This helps clarify what the function or action is intended for, making your project more understandable and maintainable—especially in libraries and collaborative environments. | |||
There was a problem hiding this comment.
--also gets added to the function code documentation (reflects in code editor too)
|
Hi @PoojaB26 could you please quickly take a look again? |
|  | ||
|
|
||
| :::tip | ||
| In the generated code, descriptions are added as comments above the custom code. In code editors, they appear as tooltips when you hover over the names of Custom Functions and Actions. |
There was a problem hiding this comment.
In code editors, they appear as tooltips when you hover over the names of Custom Functions and Actions
Is this true though?
I mean its true in actions flow and properties editor, but not in custom code tab. which is what i mean by code editors. it only adds the description as a comment before the function definition.
There was a problem hiding this comment.
Oops! My bad—I thought you were referring to IDEs when you said "code editor" No worries though, I’ve updated the text and added an image to make it more clear. Thanks for looking into :)
Description
Added description field info for custom functions and actions.
Linear ticket and magic word Fixes DEVR-872
Type of change