From 1caa7a7cff87b3d9b461083bb4899956b94cf69a Mon Sep 17 00:00:00 2001 From: Eneko Martin-Martinez Date: Mon, 15 Aug 2022 16:34:07 +0200 Subject: [PATCH] Correct typos --- docs/development/guidelines.rst | 2 +- docs/getting_started.rst | 2 +- docs/structure/structure_index.rst | 4 ++-- docs/whats_new.rst | 1 + 4 files changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/development/guidelines.rst b/docs/development/guidelines.rst index a3333dd5..e1f884f8 100644 --- a/docs/development/guidelines.rst +++ b/docs/development/guidelines.rst @@ -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 `_ 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 `_ 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 diff --git a/docs/getting_started.rst b/docs/getting_started.rst index d3cf8456..048a6679 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -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'] diff --git a/docs/structure/structure_index.rst b/docs/structure/structure_index.rst index e981f832..55ace1b0 100644 --- a/docs/structure/structure_index.rst +++ b/docs/structure/structure_index.rst @@ -21,11 +21,11 @@ Translation xmile_translation abstract_model -PySD currentlty supports translation :doc:`from Vensim ` amb :doc:`from Xmile `. +PySD currentlty supports translation :doc:`from Vensim ` and :doc:`from Xmile `. PySD can import models in Vensim's \*.mdl file format and in XMILE format (\*.xml, \*.xmile, or \*.stmx file). `Parsimonious `_ is the Parsing Expression Grammar `(PEG) `_ 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 `. -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)) diff --git a/docs/whats_new.rst b/docs/whats_new.rst index fb6d5bf7..353baa80 100644 --- a/docs/whats_new.rst +++ b/docs/whats_new.rst @@ -18,6 +18,7 @@ Bug fixes Documentation ~~~~~~~~~~~~~ +- Correct typos. Performance ~~~~~~~~~~~