logica icon indicating copy to clipboard operation
logica copied to clipboard

Annotation documentation/wiki entry

Open jhuff-ccsw opened this issue 7 months ago • 2 comments

It would be useful to have a comprehensive list of @ annotations and their functionality. I'm unsure if there's a way for me to contribute to the wiki, but I'd be willing to start a new markdown document under /docs/learn, though I would likely need help filling out the descriptions for all the annotations.

If you have other ideas about how this documentation should be organized, let me know.

jhuff-ccsw avatar Apr 29 '25 17:04 jhuff-ccsw

/docs/learn/logica.md states:

"The predicate here is @Engine. Special predicates that start with @Engine are called imperatives. The predicates are used to command to the Logica engine on what to do."

First, did this mean to say "Special predicates that start with @ are called imperatives"?

Second, elsewhere in the codebase, these are referred to as annotations rather than imperatives. Should this be changed to "annotations" here?

jhuff-ccsw avatar Apr 29 '25 17:04 jhuff-ccsw

@jhuff-ccsw Hi, we are currently developing a website for Logica and here is the cheatsheet for imperatives https://logica-web.github.io/usrguide/imperatives.html

yilinxia avatar May 10 '25 03:05 yilinxia