Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for abort statement is missing #211

Open
lesquoyb opened this issue Mar 4, 2024 · 2 comments
Open

Documentation for abort statement is missing #211

lesquoyb opened this issue Mar 4, 2024 · 2 comments
Assignees
Labels
GAMA Generation ⚙ Problem coming from GAMA inbuilt documentation generation, fix have to be done on the Java code side Improve content ✒️

Comments

@lesquoyb
Copy link
Collaborator

lesquoyb commented Mar 4, 2024

Describe the bug
As the title says, there's no documentation for that statement.
Here is what I found about it:

  • the keyword is listed in the exhaustive list of statement as it should
  • however following the link from this page doesn't lead to anything, we are directed to the statements page that do not contain the abort keyword
  • when hovering the abort keyword in gama I get the description of a reflex
  • I can't find much code about that statement, not even a dedicated class

So my guess is that it simply is lacking documentation in the gama code

@lesquoyb lesquoyb added Improve content ✒️ GAMA Generation ⚙ Problem coming from GAMA inbuilt documentation generation, fix have to be done on the Java code side labels Mar 4, 2024
@lesquoyb lesquoyb removed this from GAMA 2024-11 Jun 24, 2024
@benoitgaudou
Copy link
Contributor

abort (and similarly init) are some particular cases of reflex.
As it, they are documented with this stamement, cf. definition of the reflex statement.

Reflexes are sequences of statements that can be executed by the agent. Reflexes prefixed by the 'reflex' keyword are executed continuously. Reflexes prefixed by 'init' are executed only immediately after the agent has been created. Reflexes prefixed by 'abort' just before the agent is killed. If a facet when: is defined, a reflex is executed only if the boolean expression evaluates to true.

Is it not enough ?

Do we need to add (as for operators) the abort and init in the list of statements, and put only a link to reflex ?

@lesquoyb
Copy link
Collaborator Author

lesquoyb commented Jun 27, 2024

I think it would be nice for the users indeed, because they could research it through the website if it's registered in the statement list. Because currently you cannot even find it with the search engine

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
GAMA Generation ⚙ Problem coming from GAMA inbuilt documentation generation, fix have to be done on the Java code side Improve content ✒️
Projects
None yet
Development

No branches or pull requests

2 participants