Skip to content

Commit 81bb1b7

Browse files
committed
#285 Fix docs grammar and formatting
1 parent 2032a4d commit 81bb1b7

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

‎docs/index.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ Sympy or any other python package may need to be updated, especially as python v
1818
- ``git add``, ``git commit`` and ``git push`` the changes
1919
- Make a pull request. The tests may throw up some errors that may need fixing. The tests are in the tests folder and the reference data in data/tests.
2020
- Sympy occasionally changes the exact (but mathematically equivalent) form of the generated code between versions.
21-
To cope with this, a reference file may have per-sympy-version variants named ``<name>--sympy_X_Y.<ext>`` (e.g. ``<model>--sympy_1_13.cpp``) alongside the base file.
22-
To regenerate the reference data for a new sympy version, run the tests with the ``CHASTE_CODEGEN_REGENERATE_REFERENCES`` environment variable set (this writes the generated output to ``<reference>.regen.<X>.<Y>`` files).
21+
To cope with this, a reference file may have per-sympy-version variants named ``<name>--sympy_X_Y.<ext>`` (e.g. ``<model>--sympy_1_13.cpp``) alongside the base file.
22+
To regenerate the reference data for a new sympy version, run the tests with the ``CHASTE_CODEGEN_REGENERATE_REFERENCES`` environment variable set (this writes the generated output to ``<reference>.regen.<X>.<Y>`` files).
2323
- Mention the changes made in the release notes ``release.txt``
2424
- To use the changes with chaste, do a new release of chaste_codegen.
2525

@@ -31,7 +31,7 @@ Updating the ontology and including it in chaste_codegen
3131
- *Please note* this same way can be used to update the ``cellml`` in ``chaste_codegen/data/tests/cellml`` submodule if required.
3232
- Create a new branch ``git checkout -b <name_of_new_branch>``
3333
- ``git add``, ``git commit`` and ``git push`` the changes
34-
- Make a pull run the tests and fix any issues that arise
34+
- Make a pull request, run the tests and fix any issues that arise
3535
- Update the release notes ``release.txt`` with information about the updated ontology.
3636
- To use the changes with chaste, do a new release of chaste_codegen.
3737

0 commit comments

Comments
 (0)