Is there an expression or component that can display the documentation of a rule on an interface the way it appears when coding?
Discussion posts and replies are publicly visible
I don't think this exists. But, what are you looking for, aka. for what purpose?
As I have been working on an application for utilities, I would like to offer a dynamic interface to share documentation for utility objects, similar to the format used in Appian Documentation.
AFAIK, most development teams, including mine, do this by having a small application which just holds these shared assets. Are you sure you need a separate UI for this?
That's correct and TBH I'm not sure. I am just looking if there is any possibility.
I wish I could list the useful objects and giving examples of usage.
But anyways, I am looking for this because in python there is the `help()` function which receives another function as parameter and displays its docstring
In Appian by default the rule description is displayed below the expression editor when you click within the brackets after rule name. Generally we rely on the same to understand the rule's functionality. So for your utility objects you can provide a detailed description and user's can get insights while using the rule.
So, alternate to help() function, simply clicking inside rule parentheses can give the description as well as intended parameter details. Generally all devs are familiar with this as well. Hope this helps.