argumentcomputer / lurk

Lurk is a Turing-complete programming language for zk-SNARKs. It is a statically scoped dialect of Lisp, influenced by Scheme and Common Lisp.
https://docs.argument.xyz
MIT License
46 stars 3 forks source link

Fixed meta command summaries #383

Closed gabriel-barrett closed 1 week ago

arthurpaulino commented 2 weeks ago

Thanks! But this is not following the documentation model from other commands. The summary would say something like "Retrieves the current state from a microchain ...". The return is already specified in the "return" field

gabriel-barrett commented 2 weeks ago

Thanks! But this is not following the documentation model from other commands. The summary would say something like "Retrieves the current state from a microchain ...". The return is already specified in the "return" field

I understand the use of retrieve in a few cases, when it retrieves data from the web, but return has a very specific meaning, that of the return value of the metacommand when used inside an expression. I would rather update the comment to "retrieve and return".

EDIT: there's a single use of "retrieve". I think return makes more sense in all cases

arthurpaulino commented 2 weeks ago

All meta commands return something (hence the "Returns" field). If we describe all of them as "Returns ...", it's going to be an annoyance for what !(help) prints.

Plus, the return is already specified. No need to duplicate the information.

gabriel-barrett commented 2 weeks ago

All meta commands return something. If we describe all of them as "Returns ...", it's going to be an annoyance for what !(help) prints

Yes, but you're proposing I change the name to "retrieve" only so it's a different word, as to not look repetitive. There's no reason to change any of the other summaries I believe. Most return values are pro forma, and not really relevant, and in a few cases the return value is of limited utility, used in a few cases. In this instance, the return value is integral to the command. The command is useless without the return value