Hi All,
I am facing a challenge with AI Mentor , it flagged out a missing description on a client action. I provided the description and set it to "Already fixed", however the following day when I checked ,the same action was still flagged for missing description , any idea why this is happening ?
Hello,
Just to remind, if you read the whole sentence it says Missing descriptions on public element or parameter so make sure to add descriptions in actions as well as both input and output parameters.
Thank you
Yeah , thanks. I was missing descriptions on the parameters as well
Things to be taken care in Missing Description warning removal:
In general, it is a good programming practice to provide each individual description for a good understanding and documentation.
Module - Add a description to the module that explains the purpose and identifies the concepts it contains.
Module Public Elements (Public Actions and Their Input / Output Parameters) - To have the finding solved, add meaningful descriptions to all modules' public elements and their related parameters.
Entities & Structure
The only exceptions are Entities and Structures attributes whose descriptions are optional and parameters whose names already follow well-established naming conventions (e.g. Id, Name, Label, Description, CreatedBy, UpdatedBy, CreatedOn, UpdatedOn).
Ok but If I have like the LayoutBase missing description the OS need to update that and make it automatically
Sometimes warnings are associated with other forge component or may be part of the OS. These types of warnings, we cannot fix and should be resolved as "Would not Fix" in the AI Mentor Studio.
Also, Outsystem provides the way to ignore the modules which we are not an owner or completely would like to skip for tech debt. In AI Mentor Studio, we can ignore the modules for tech debt which we cannot fix. It can be done under the Maintenance Menu.
I also experienced this. Even with a valid description the AI mentor does not update that the public element actually has a description
Hi I am having this same issue, any updates?
Hi! Are you sure, that all the input and output parameters have descriptions, not only actions?
Oh I see I was only checking the description itself of the action.