Skip to content

Commit

Permalink
[Genstar] add more doc details
Browse files Browse the repository at this point in the history
  • Loading branch information
chapuisk committed Jul 15, 2021
1 parent feb95e0 commit f4aa55e
Showing 1 changed file with 8 additions and 3 deletions.
Expand Up @@ -28,6 +28,7 @@
import msi.gama.precompiler.GamlAnnotations.symbol;
import msi.gama.precompiler.GamlAnnotations.usage;
import msi.gama.precompiler.IConcept;
import msi.gama.precompiler.IOperatorCategory;
import msi.gama.precompiler.ISymbolKind;
import msi.gama.runtime.IScope;
import msi.gama.runtime.exceptions.GamaRuntimeException;
Expand Down Expand Up @@ -60,6 +61,7 @@
kind = SEQUENCE_STATEMENT,
with_sequence = true,
with_args = true,
category = { IOperatorCategory.GENSTAR },
concept = { IConcept.SPECIES },
remote_context = true)
@inside (
Expand All @@ -70,7 +72,8 @@
name = SPECIES,
type = { IType.SPECIES, IType.AGENT },
optional = true,
doc = @doc ("The species of the agents to be created.")),
doc = @doc ("The species of the agents to be created.")
),
@facet (
name = FROM,
type = IType.NONE,
Expand All @@ -80,7 +83,8 @@
+ " <li>list of csv_file: can be aggregated or micro data</li>\n"
+ " <li>matrix: describe the joint distribution of two attributes</li>\n"
+ " <li>bayesian network: describe a conditional distribution of three or more attributes</li>"
+ "</ul>")),
+ "</ul>")
),
@facet (
/*
* TODO : make those attributes like in csv map
Expand All @@ -98,7 +102,8 @@
optional = true,
doc = @doc ("To specify the number of created agents interpreted as an int value. "
+ "If facet is ommited or value is 0 or less, generator will treat data used in the 'from' facet as contingencies "
+ "(i.e. a count of entities) and infer a number to generate (if distribution is used, then only one entity will be created")),
+ "(i.e. a count of entities) and infer a number to generate (if distribution is used, then only one entity will be created")
),
@facet (
name = GenStarConstant.GSGENERATOR,
type = { IType.STRING },
Expand Down

0 comments on commit f4aa55e

Please sign in to comment.