ExternalVendorCode/trick
1
0
Fork 0
mirror of https://github.com/nasa/trick.git synced 2024-12-18 20:57:55 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix some typos in documentation (#1128)

Browse Source 
* Fix typo

* typos, grammar
This commit is contained in:
Matas Lauzadis 2021-05-26 22:14:42 -05:00 committed by GitHub
parent 832fc4e8a7
commit 7008e8bac7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/documentation/building_a_simulation/Model-Source-Code.md
View File

@ -155,7 +155,7 @@ Best practice is to add library dependencies for source code files for prototype
###### `ICG_IGNORE_TYPES`
The `ICG IGNORE TYPES` field lists the structs or classes to be ignored. Any parameters of this type or inherited from are ignored. The `ICG IGNORE TYPES` field only valid for the current file. It does not extend to included header files.
The `ICG IGNORE TYPES` field lists the structs or classes to be ignored. Any parameters of this type or inherited from are ignored. The `ICG IGNORE TYPES` field is only valid for the current file. It does not extend to included header files.
###### `PYTHON_MODULE`
@ -242,7 +242,7 @@ Trick allows any data type declaration within the data structure `typedef` state
1 `(un)signed short`,
1 `(un)signed long`,
1 `(un)signed char`,
1 `(un)singed long long`,
1 `(un)signed long long`,
1 `(un)signed short int`,
1 `(un)signed long int`,
1 `float`,
@ -330,14 +330,14 @@ Each parameter declaration within a data structure definition may be accompanied
The first three fields in the parameter comment are optional and specify the input/output processing for the parameter. I/O permissions may be set globally or individual capabilities may set their permissions separately. I/O permissions for checkpointing is available to set separately.
To set all permissions for general variable access start the comment with one of the following fields, `[**|*i|*o|*io]`. `trick_io([**|*i|*o|*io])` or `io([**|*i|*o|*io])` are equivalent forms to set general variable access.
To set all permissions for general variable access, start the comment with one of the following fields, `[**|*i|*o|*io]`, `trick_io([**|*i|*o|*io])` or `io([**|*i|*o|*io])`. These are equivalent forms to set general variable access.
* `**` indicates that Trick will not allow input or output for this parameter; i.e. the user can not input this parameter,record this parameter, or view its value.
* `**` indicates that Trick will not allow input or output for this parameter; i.e. the user can not input this parameter, record this parameter, or view its value.
* `*i` indicates that only input is allowed for the parameter. Parameter may be input through the checkpoint file or ref_assignment, but the parameter will not be recordable or written to a checkpoint file.
* `*o` indicates only output is allowed for the parameter. Parameter may be checkpointed or logged only. They are not reloaded during a checkpoint reload.
* `*io` specifies that both input and output are allowed for the parameter. This is the default condition if the field is omitted from the comment. Parameter may be in input file, may be checkpointed and logged.
Checkpoint I/O may be set separately by adding `trick_chkpnt_io([**|*i|*o|*io])` or `cio([**|*i|*o|*io])` to the comment. If this optional field is not present the general I/O access field is used to determine checkpoint permissions.
Checkpoint I/O may be set separately by adding `trick_chkpnt_io([**|*i|*o|*io])` or `cio([**|*i|*o|*io])` to the comment. If this optional field is not present, the general I/O access field is used to determine checkpoint permissions.
* `**` indicates that Trick will not allow checkpoint input or output. General variable access may still be available.
* `*i` indicates only checkpoint input is allowed for the parameter. Parameters will not be written to the checkpoint.

2
docs/tutorial/ATutIntroduction.md
View File

@ -20,7 +20,7 @@
Trick is a NASA Open Source simulation framework for running time-based physics
models. It builds executable simulations with a common architecture, using user
supplied simulation definition files and user supplied "model code". A Trick
based simulation, provides many capabilities such realtime
based simulation provides many capabilities such as realtime
synchronization, job scheduling, simulation state save and restore (checkpoint),
data-recording, interactive variable manipulation (variable server), numeric
state integration and an input processor. It also includes tools for plotting