search

StefanMaron / BusinessCentral.LinterCop

Community driven code linter for AL (MS Dynamics 365 Business Central)
https://stefanmaron.com
MIT License
77 stars 31 forks source link

LC0038 should be ignored for very long tooltips/instruction texts. #437

Closed ernestasjuska closed 10 months ago

ernestasjuska commented 10 months ago

Hi,

Tooltips and instruction texts can be very long and AL does not have means for breaking long text literal into multiple lines. So the analyzer should not show a problem in this case.

For example: image

                    field(InclClosingEntriesWithinPeriod; PrintClosingEntries)
                    {
                        ApplicationArea = Basic, Suite;
                        Caption = 'Include Closing Entries Within the Period';
                        MultiLine = true;
                        ToolTip = 'Specifies if you want the report to include closing entries. This is useful if the report covers an entire fiscal year. Closing entries are listed on a fictitious date between the last day of one fiscal year and the first day of the next one. They have a C before the date, such as C123194. If you do not select this field, no closing entries are shown.';
                    }

Thanks.

Arthurvdv commented 10 months ago

The documentation of the rule explains on the why and also references to the guidelines from Microsoft on this.

The Microsoft User assistance model suggests for a ToolTip to try to not exceed 200 characters including the spaces.

https://github.com/StefanMaron/BusinessCentral.LinterCop/wiki/LC0038

What do you suggest we could further improve this?

ernestasjuska commented 10 months ago

Yes, you are right. The right way is to shorten the tooltip.