ThatOpen / engine_docs

https://docs-one-orpin.vercel.app
9 stars 11 forks source link

Creating Components Tutorial, Retrieve Tools outdated. #26

Closed ArturTecnet closed 4 months ago

ArturTecnet commented 10 months ago

Describe the bug πŸ“

In this tutorial the retrieval of tools is explained like this:

const hwTool = await components.get(HelloWorldTool.uuid);

but it works with the tools attribute and without the uuid like this:

const hwTool = await components.tools.get(HelloWorldTool);

Also the tutorial should note, that the retrieval only works, if the components constructor doesn’t get other parameters than OBC.Components. If the class needs more to function, I would recommend to write a setup() Method that takes everything else.

Reproduction ▢️

No response

Steps to reproduce πŸ”’

No response

System Info πŸ’»

Not needed since the error is in the content of the docs

Used Package Manager πŸ“¦

npm

Error Trace/Logs πŸ“ƒ

No response

Validations βœ…

agviegas commented 4 months ago

Fixed!