How to format Function Documentation

Question

How to format Function Documentation

taylorh140 opened this issue 6 years ago · 7 comments

After registering a function some times the text for the function arguments is not pretty:

I used the following information for Registry:
@register(ArgumentText("Find A subset from the list which sums to specified value"w),
HelpTopic("Find A subset from the list which sums to specified value"w),
FunctionHelp("Find A subset from the list which sums to specified value"w),
ArgumentHelp(["List, contains list where subsets reside"w,"TargetValue, Goal Value for subset"w,"MaxListSize, Maximum number of subset items allowed (this makes a very large difference in calcualtion time)"w]))

I suppose what I need here is documentation on what goes where and how to format it.

Thanks!

adamdruppe commented 5 years ago

#81

Answer 1 · 2019-05-13T08:52:38.000Z

Thanks for filing the issue. How did you get the dialogs about function arguments in Excel?

Answer 2 · 2019-05-13T14:23:39.000Z

I use the fx button :)

I have Excel 2016 but I think the layout is mostly the same for previous versions.

Answer 3 · 2019-05-22T23:52:32.000Z

It's a known bug in Excel.
https://docs.microsoft.com/en-us/office/client-developer/excel/known-issues-in-excel-xll-development

Answer 4 · 2019-10-22T13:42:12.000Z

Working around the Excel bug is simple in the wrapper. It seems the ArgumentsText thing is actually a semicolon-separated list of argument names.

HelpTopic also has a specific format involving a !. I'll add some code comments in a PR at least.

Answer 5 · 2019-10-22T15:36:56.000Z

Closed by #81

Answer 6 · 2019-10-22T20:17:51.000Z

leaving this as a note to self but it might be a good idea to hard-code the install path of the excel sdk for linking instead of having to hunt down the lib

(the stupid eula prohibits redistribution, but linking to and having the path known to the default build script can be the next best thing for a smooth "just works" experience)