Kreuzberg.CodeDocstringInfo (kreuzberg v4.9.5)

Copy Markdown View Source

Docstring information with parsed sections.

Fields

  • :text - Raw docstring text
  • :format - Docstring format (e.g. "javadoc", "numpy", "google")
  • :associated_item - Name of the associated code item
  • :span - Source span
  • :sections - Parsed docstring sections

Summary

Types

t()

Functions

from_map(data)
to_map(info)

Types

t()

@type t() :: %Kreuzberg.CodeDocstringInfo{
  associated_item: String.t() | nil,
  format: String.t(),
  sections: [Kreuzberg.CodeDocSection.t()],
  span: Kreuzberg.CodeSpan.t(),
  text: String.t()
}

Functions

from_map(data)

@spec from_map(map()) :: t()

to_map(info)

@spec to_map(t()) :: map()