silverbullet icon indicating copy to clipboard operation
silverbullet copied to clipboard

Space Script documentation does not list all syscalls

Open daniel-michel opened this issue 10 months ago • 2 comments

The documentation for Space Script does not list all syscalls. It uses a query to list the syscalls, however as mentioned in #824, this does not include all syscalls which makes the documentation confusing. Also the list of syscalls in the documentation changes when activating sync mode.

daniel-michel avatar Apr 04 '24 22:04 daniel-michel

I guess since, as discussed in the other issue #824, the behavior of the query should not change. It might actually be a solution to mention that sync mode has to be enabled to show client side syscalls. Although that does not seem like a very satisfying solution.

daniel-michel avatar Apr 04 '24 23:04 daniel-michel

Yeah, not sure what to do here. I added this query source as a "hey, this is a fun way to self document" not really taking into consideration the client/server-side only calls. Perhaps it would just be better to document syscalls from the source code (JS-Doc style) rather than in this way.

zefhemel avatar Apr 07 '24 13:04 zefhemel

This is fixed by e293525. The Space Script page now links to the documentation on jsr.io.

daniel-michel avatar Aug 07 '24 19:08 daniel-michel