Forum Discussion
How to add documentation to custom functions in Power Query Custom Connector?
HI. I'm building a custom connector for Power BI, and I'd like to add documentation to my custom functions. I have read the official documentation and a few blog posts about this. I can't see what is...
Here is a sample of a more complete connector:
FunctionType = let paramType = type text meta [ Documentation.FieldCaption = ... ], t = type function (param as paramType) as table in t meta [ Documentation.Description = ..., Documentation.DisplayName = ..., Documentation.Caption = ..., Documentation.Name = ..., Documentation.LongDescription = ..., Documentation.Examples = {[ Description = ..., Code = ..., Result = ... ]} ],
artemus
Microsoft Employee
Microsoft EmployeeOh I see, I think the [DataSource.Kind = ...] is overriding the metadata you already have. You should be able to just append it to your current metadata:
[
DataSource.Kind = "CustomConnector",
Documentation.Name = "GetFunction2",
...
]
shared CustomConnector.GetFunction2 = GetFunction2
artemusMicrosoft Employee
Microsoft EmployeeActually scratch that, just add
Documentation.Description
to your origional solution
I did, but it still doesn't work. I replaced "Documentation.LongDescription" with "Documentation.Description" but it still shows like this:
- artemus
Here is a sample of a more complete connector:
FunctionType = let paramType = type text meta [ Documentation.FieldCaption = ... ], t = type function (param as paramType) as table in t meta [ Documentation.Description = ..., Documentation.DisplayName = ..., Documentation.Caption = ..., Documentation.Name = ..., Documentation.LongDescription = ..., Documentation.Examples = {[ Description = ..., Code = ..., Result = ... ]} ],Thank you for the help artemus. I'm checking that out.