search

silverbulletmd / silverbullet

The hackable notebook
https://silverbullet.md
MIT License
2.03k stars 140 forks source link

Space Script documentation does not list all syscalls #839

Open daniel-michel opened 3 months ago

daniel-michel commented 3 months ago

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 commented 3 months ago

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.

zefhemel commented 2 months ago

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.