Skip to content

API Reference search for HInstance fails to find all relevant functions #140

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
redoak opened this issue Nov 4, 2024 · 0 comments
Closed

Comments

@redoak
Copy link

redoak commented Nov 4, 2024

When making a search for HInstance in the API Reference, only a single hit is returned:

ref/stable/dmGameObject - hinstance

I would expect hits in dmScript, such as CheckGOInstance to be returned.

If I instead search for dmGameObject::HInstance, the search fails with an uncaught exception:

name: "QueryParseError"
message: "unrecognised field '*dmGameObject', possible fields: 'type', 'data'"
start: 0
end: 13
stack: "@https://unpkg.com/[email protected]/lunr.js:2978:34\n@https://unpkg.com/[email protected]/lunr.js:3471:3\n"
​​fileName: "https://unpkg.com/[email protected]/lunr.js"
​​lineNumber: 2978
columnNumber: 34

If it's too much work to improve the search results, maybe it's possible to generate a single page API Reference. Such a page would be easy to search via the browser's search function (I always have a tab with the single page Lua 5.1 Reference Manual to do quick look-ups).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant