Skip to content

Commit

Permalink
Correct typos
Browse files Browse the repository at this point in the history
  • Loading branch information
enekomartinmartinez committed Aug 15, 2022
1 parent 2102a9f commit 1caa7a7
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/development/guidelines.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ complementary tests in the corresponding `pytest_*.py` file.

.. note::
If your changes correct some existing bug related to the translation or running
of a Vensim (or Xmile) model. You should add a new test in the `test suite repo <https://github.com/SDXorg/test-models>`_ reproducing the solved bug and addthe necessary lines in `pytest_integration/pytest_integration_test_vensim_pathway.py` (or `pytest_integration/pytest_integration_test_xmile_pathway.py`) to run the new test. Then, it is encoraged to add also unit test in `pytest_translators` reproducing the translation of the new function and test of the workflow in
of a Vensim (or Xmile) model. You should add a new test in the `test suite repo <https://github.com/SDXorg/test-models>`_ reproducing the solved bug and addthe necessary lines in `pytest_integration/pytest_integration_test_vensim_pathway.py` (or `pytest_integration/pytest_integration_test_xmile_pathway.py`) to run the new test. Then, it is encouraged to add also unit test in `pytest_translators` reproducing the translation of the new function and test of the workflow in
`pytest_types/functions/pytest_functions.py` (or `pytest_types/statefuls/pytest_statefuls.py`).

Speed Tests
Expand Down
2 changes: 1 addition & 1 deletion docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ There are times when we may choose to overwrite a stock with a constant value (i

Querying current values
-----------------------
We can easily access the current value of a model component using curly brackets. For instance, to find the temperature of the teacup, we simply call::
We can easily access the current value of a model component using square brackets. For instance, to find the temperature of the teacup, we simply call::

>>> model['Teacup Temperature']

Expand Down
4 changes: 2 additions & 2 deletions docs/structure/structure_index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ Translation
xmile_translation
abstract_model

PySD currentlty supports translation :doc:`from Vensim <vensim_translation>` amb :doc:`from Xmile <xmile_translation>`.
PySD currentlty supports translation :doc:`from Vensim <vensim_translation>` and :doc:`from Xmile <xmile_translation>`.

PySD can import models in Vensim's \*.mdl file format and in XMILE format (\*.xml, \*.xmile, or \*.stmx file). `Parsimonious <https://github.com/erikrose/parsimonious>`_ is the Parsing Expression Grammar `(PEG) <https://en.wikipedia.org/wiki/Parsing_expression_grammar>`_ parser library used in PySD to parse the original models and construct an abstract syntax tree. The translators then crawl the tree, using a set of classes to define the :doc:`Abstract Model <abstract_model>`.

When parsing the expressions of any language, the order of operations must be taken into account. The order is shown in the following table and is used to create :py:class:`ArithmeticStructure` and :py:class:`LogicalStructure` objects correctly. The following expression :py:data:`1+2*3-5`` will be translated to::
When parsing the expressions of any language, the order of operations must be taken into account. The order is shown in the following table and is used to create :py:class:`ArithmeticStructure` and :py:class:`LogicalStructure` objects correctly. The following expression :py:data:`1+2*3-5` will be translated to::

ArithmeticStructure(operators=['+', '-'], arguments=(1, ArithmeticStructure(operators=['*'], arguments=(2, 3)), 5))

Expand Down
1 change: 1 addition & 0 deletions docs/whats_new.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Bug fixes

Documentation
~~~~~~~~~~~~~
- Correct typos.

Performance
~~~~~~~~~~~
Expand Down

0 comments on commit 1caa7a7

Please sign in to comment.