Skip to content

Commit 1caa7a7

Browse files
Correct typos
1 parent 2102a9f commit 1caa7a7

File tree

4 files changed

+5
-4
lines changed

4 files changed

+5
-4
lines changed

docs/development/guidelines.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ complementary tests in the corresponding `pytest_*.py` file.
3535

3636
.. note::
3737
If your changes correct some existing bug related to the translation or running
38-
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
38+
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
3939
`pytest_types/functions/pytest_functions.py` (or `pytest_types/statefuls/pytest_statefuls.py`).
4040

4141
Speed Tests

docs/getting_started.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ There are times when we may choose to overwrite a stock with a constant value (i
239239

240240
Querying current values
241241
-----------------------
242-
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::
242+
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::
243243

244244
>>> model['Teacup Temperature']
245245

docs/structure/structure_index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ Translation
2121
xmile_translation
2222
abstract_model
2323

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

2626
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>`.
2727

28-
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::
28+
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::
2929

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

docs/whats_new.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ Bug fixes
1818

1919
Documentation
2020
~~~~~~~~~~~~~
21+
- Correct typos.
2122

2223
Performance
2324
~~~~~~~~~~~

0 commit comments

Comments
 (0)