ek9_help
Returns the reference page for one keyword, built-in type or topic - hover summary, the full type API for a built-in type, usage examples - or the keyword index when no keyword is given.
When to use it
'What is X' or 'what does String offer' is one call with keyword:'String' - the language reference for one keyword, built-in type or topic. Spelling and case are resolved for you ('stdout' -> 'Stdout'); omit keyword for the index of every page.
When not to use it
- How-to or why questions ('how do I write a switch', 'why no break?') - use
ek9_ask. - A construct in THE USER'S workspace (their own class/function/module) - use
ek9_query_construct, orek9_query_effective_apifor its full API. - Priming a session with the whole EK9 paradigm - use
ek9_paradigm. - One error code's meaning (E07235) - use
ek9_explain_error.
Details
Plain text. Resolution order: exact page, EK9 error code (E + 5 digits, answered with the rich explanation), case-insensitive page ('list' -> List), then the closest page within four edits - a correction is announced on the first line. Operators are looked up by their symbol (keyword:'<=>' or '#?'). A true miss is an error (not an empty success) listing related topics from the concept registry. Static reference content, independent of workspace compile state; the type API is introspected from org.ek9.lang once per server.
Arguments
| Argument | Type | Required | What it is |
|---|---|---|---|
keyword | string | The keyword, type name, operator symbol or topic (e.g. 'String', 'switch', '<=>', 'E05030'); case and near spellings are resolved. Omit for the index of every page. |
See also
- Show me in the IDE: Chapter 7: asking about a type