[PowerBI/PowerQuery] Function that translates the documentation attached to a function definition into Markdown text

100%

[PowerBI/PowerQuery] Function that translates the documentation attached to a function definition into Markdown text

✓ Published0🌍 Public

Last edited Mar 7, 2018

Created on Feb 12, 2018

This example demonstrates a Power Query function that converts the documentation embedded in a function’s type metadata into a Markdown-formatted text block. It first retrieves the function from Power BI’s shared namespace, then extracts fields such as description, long description, category, and examples from the `Value.Metadata` of the function’s type. The code handles missing fields with `try`/`otherwise`, and uses `Text.Trim`, `Lines.ToText`, and `List.Transform` to assemble a template with headers and code fences. The final output is a Markdown document suitable for gallery display, relying solely on the function’s own metadata as the data source.

AI-generated description

Similar vizzes

Loading thumbnail…

[PowerBI/PowerQuery] This script works in combination with doc2markdown(fn) to load the documentation from #shared functions into the Model

This example shows how to generate Markdown documentation for all functions defined in Power Query’s `#shared` namespace, organizing them by category and module. It uses the `doc2markdown` helper to produce a Markdown table of functions, excluding the helper itself and the `Signature` function. The script leverages `Record.ToTable` to enumerate shared items, `Table.SelectRows` with `Type.Is` to filter for functions, and `Value.Metadata` to extract `Documentation.Category` attributes. It then adds columns for category, module, and subcategory using `Text.BeforeDelimiter` and `Text.AfterDelimiter`, culminating in a `dox` table with function names and their generated documentation.

HHugoberry

80% match

Loading thumbnail…

Gist 8e3363becb45788f796a2b31aaa4c6b3

This example shows how to programmatically generate Markdown documentation from Power Query’s metadata system, specifically pulling the name, description, category, and examples for the `SqlExpression.SchemaFrom` type. It works by reading the type’s metadata via `Value.Metadata` and `Value.Type`, then formatting the results into a structured document with headers, code blocks, and separators. The code uses the `Lines.ToText` and `List.Transform` functions to assemble the output, while `Documentation.Examples` iterates over sample entries to embed their code and results. The final output is a plain-text Markdown string, ready for use in a gallery or README.

HHugoberry

78% match

Loading thumbnail…

Power Query navigate the documentation of #shared functions. [M code]

This example visualizes the complete set of functions exposed by Power Query’s `#shared` namespace, organized into a navigable table. It shows each function’s name, module, category, example code, description, and signature. The M code uses `Record.ToTable` and `Table.SelectRow` to filter functions, then leverages `Value.Metadata` to extract documentation fields like `Documentation.Category` and `Documentation.Examples`. It also parses module names via `Text.Split` and builds signatures dynamically. The result is a self-documenting inventory, enabling users to browse and understand the entire Power Query function library directly from the environment.

HHugoberry

71% match

Loading thumbnail…

[PowerBI/PowerQuery/PowerShell] Retrieve the documentation that has been nicely packaged by dox query into the tabular Model

This example retrieves documentation from Power BI’s embedded tabular model and writes it into markdown files organized by module and subcategory. It shows how to extract metadata from the model’s internal `dox` table using an XMLA query, then sorts and groups the results by module and name. The script uses PowerShell with the `Invoke-ASCmd` cmdlet from the SQLServer module, reading the localhost port from `msmdsrv.port.txt`, and writes each documentation row’s `doc` value to a `.md` file, escaping `{{` and `}}` for template compatibility. The output folder structure mirrors the module and subcategory hierarchy, with folders created on demand.

HHugoberry

70% match

Loading thumbnail…

Power Query - get signature of a function as text. Use Signature(Table.Buffer) equals "function (table as table) as table". This is an M script

This example demonstrates how to extract and display the signature of a Power Query function as readable text, using the M language. It defines a custom function that takes a function as input and returns its type signature, such as `function (table as table) as table`. The code serializes type information into text form using the `Type.Is` and `Type.IsNullable` functions, then iterates over parameter names and their types via `Type.FunctionParameters` and `Record.FieldNames`. It assembles the final signature with `Text.Combine`, handling optional parameters and nullable types, and appends the return type using `Type.FunctionReturn`. The result is a string representation of the function's contract.

HHugoberry

67% match

Loading thumbnail…

Gist f3a61a41e6832de955bdf750f4c54ba3

This example demonstrates a custom Power Query function that multiplies its input by a metadata value retrieved from a previously invoked function. The visualization shows how dynamic metadata can influence computed results within a data transformation pipeline. The code uses the `Expression.Evaluate` API to access the `Value.Metadata` function, pulling the `[a]` field from shared context, then multiplies that value by the parameter `x`. The rendering approach is not visual; instead, it highlights programmatic data shaping in Power Query, with the function `fn.pq` serving as the core logic. The source is a single gist file authored by Hugoberry.

HHugoberry

62% match

Loading thumbnail…

[Power Query] Replace an unary function type with a custom type that contains metadata for allowed parameter values

This example demonstrates how to replace an unary function type with a custom type that carries metadata for allowed parameter values. The code defines a function `setParameters` that accepts a function `f` and a list `allowedValues`, then constructs a new parameter type using `Value.Type` and attaches documentation metadata via `meta`. It builds a function type with `type function` and applies it using `Value.ReplaceType` to modify the original function’s type. The implementation relies on Power Query’s `Value.Type` and `Value.ReplaceType` APIs, with metadata defined by `Documentation.AllowedValues` for parameter validation.

HHugoberry

60% match

Loading thumbnail…

Gist fad134c9dcebee3dc1c56a9cb22de435

This example demonstrates a Power Query M function that serializes a table into a JSON object and then passes that JSON to a SQL Server stored procedure, `usp_InsertDemoJSON`, which unwraps it as a recordset and performs an INSERT operation. The code uses `Text.FromBinary` and `Json.FromValue` to convert the table, then `Value.NativeQuery` to execute the stored procedure with the JSON payload. It shows a data pipeline from a Power BI or Excel data source into a SQL database, relying on the M language’s native JSON handling and SQL Server’s JSON support.

HHugoberry

60% match