pkl icon indicating copy to clipboard operation
pkl copied to clipboard

[docs] Improve searchability of "Methods" section

Open HT154 opened this issue 1 year ago • 2 comments

The primary goal here is to have this section appear first (or at least high) when using the docs search for "function". I'm not fully satisfied with this solution, so open to alternative suggestions.

HT154 avatar Aug 13 '24 02:08 HT154

Maybe “In a strict sense, Pkl does not have functions.”

Not totally sure what this means. Do you mean to express that functions in Pkl have this as a receiver, so the result of a function is not just defined in terms of of the function's explicit arguments?

bioball avatar Aug 16 '24 19:08 bioball

Simplified this back down to just adding reference to the function keyword.

I'm a bit bummed about the header not including "function" as it likely pushes this below several other sections in the search. Ideally the antora lunr extenion would support indexing hints so "function" could be added as a hint for this section to address that, but alas.

HT154 avatar Aug 16 '24 21:08 HT154