std:hikari/doc リファレンス

import doc := "std:hikari/doc" で取得する言語リファレンスメタデータモジュール。hikari doc が描くのと同じ生成済みエントリ (entries) と生成物注記の定型文 (generated_notice) を提供する。

entries

entries()
entries: {| List(Entry) }

言語リファレンスの全エントリの List を返す。Entry は name / title /
form / doc / kind / module / target / receiver / namespace
(すべて String) と examples: List(Example) を持つ。Example は
{ exprs: List(String), expected: List(String), mode: String |}。
kind は library / syntax、mode は verify / run_only / parse_only。
語彙は将来追加されうる。

>>> import doc := "std:hikari/doc"
>>> doc.entries!.length! > 0

generated_notice

generated_notice
generated_notice: String

生成物 Markdown に付く注記の定型文。リファレンスを後段加工するツールが
注記段落を認識・除去するために使う。

>>> import doc := "std:hikari/doc"
>>> doc.generated_notice.length! > 0