explain
explain(topic, *, lang='en')Return the :class:Explainer for a method or concept.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| topic | str | A topic key or alias (see :func:list_topics). |
required |
| lang | str | Language code. Only "en" ships today; the parameter is reserved so that adding translations later is non-breaking. |
'en' |
Returns
| Name | Type | Description |
|---|---|---|
| Explainer | The matching explainer. |
Raises
| Name | Type | Description |
|---|---|---|
| KeyError | If topic is unknown; the message lists the available topics. |
Examples
from geometrics.pedagogy import explain
explain("beta_convergence").title