SnakeBridge.Docs.MarkdownConverter (SnakeBridge v0.16.0)

Converts parsed Python docstrings to Elixir ExDoc Markdown format.

This module transforms structured docstring data into Markdown that is compatible with ExDoc and follows Elixir documentation conventions.

Summary

convert(parsed)

Converts a parsed docstring structure to ExDoc Markdown format.

Converts a Python doctest example to Elixir iex format.

Converts a Python exception type to an Elixir exception module.

Converts a Python type annotation to an Elixir typespec format.

@spec convert(map()) :: String.t()

Converts a parsed docstring structure to ExDoc Markdown format.

parsed - A map with keys: :short_description, :long_description, :params, :returns, :raises, :examples

A Markdown string suitable for use in @doc or @moduledoc.

@spec convert_example(String.t()) :: String.t()

Converts a Python doctest example to Elixir iex format.

iex> MarkdownConverter.convert_example(">>> func(1, 2)\n3")
"    iex> func(1, 2)\n    3"

@spec convert_exception(String.t() | nil) :: String.t()

Converts a Python exception type to an Elixir exception module.

iex> MarkdownConverter.convert_exception("ValueError")
"ArgumentError"

@spec convert_type(String.t() | nil) :: String.t()

Converts a Python type annotation to an Elixir typespec format.

iex> MarkdownConverter.convert_type("int")
"integer()"

iex> MarkdownConverter.convert_type("list[str]")
"list(String.t())"