Skip to main content

Module formatting

Module formatting 

Source

Structs§

MarkdownOptions
Options for Markdown conversion.

Enums§

FormatError
Error returned by the surface formatters.
FormatOutput
Polymorphic return for the surface formatters.
GroupBy
Group-by axis for format_modules.
MarkdownError
Error returned by to_markdown.
ModuleStyle
Module render style.
SchemaStyle
Schema render style.

Functions§

format_csv
Render rows as RFC 4180 CSV.
format_jsonl
Render rows as JSON Lines. Each row is canonical compact JSON; LF terminator; no trailing blank line.
format_module
Render a single ScannedModule for the chosen surface.
format_modules
Render a sequence of ScannedModule for the chosen surface.
format_schema
Render a JSON Schema for a specific surface.
to_markdown
Convert a JSON object to a Markdown string.