Skip to content

Commit f329903

Browse files
Apply suggestions from code review
Thanks for the review! These were all reasonable suggestions. Most of the text in "introduction.md" actually came from the referenced paper, so the text fixes should be in there. For me this is a placeholder anyway, as I think Eva and/or Bandan should write these parts. For now i just accepted your contributions, which made it more readable. Co-authored-by: Alexander Hadjiivanov <43831101+cantordust@users.noreply.github.com>
1 parent 1d22889 commit f329903

3 files changed

Lines changed: 10 additions & 10 deletions

File tree

README.dev.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33

44
## Note
55

6-
Testing and contributing is very welcome, especially if you can contribute with new algorithms and features.
6+
Testing and contributing is very welcome, especially if you can contribute new algorithms and features.
77

88

99
# Development
1010

1111
## Building the documentation locally
1212

13-
Documentation is generated with [Sphinx](https://www.sphinx-doc.org/) and [Doxygen](https://www.doxygen.nl/) (for automatically generating the technical documentation) with [Breathe](https://breathe.readthedocs.io/) providing a bridge between the Sphinx and Doxygen documentation systems. To build the documentation locally follow these steps:
13+
Documentation is generated with [Sphinx](https://www.sphinx-doc.org/) and [Doxygen](https://www.doxygen.nl/) (for automatically generating the technical documentation), with [Breathe](https://breathe.readthedocs.io/) providing a bridge between the Sphinx and Doxygen documentation systems. To build the documentation locally, follow these steps:
1414

1515
### Linux
1616
Install doxygen:
@@ -19,19 +19,19 @@ Install doxygen:
1919
sudo apt install doxygen
2020
```
2121

22-
Then, from the root of the repository install Sphinx and the other Python dependencies:
22+
Then, install Sphinx and the other Python dependencies from the root of the repository:
2323

2424
```
2525
python -m venv .venv
2626
source .venv/bin/activate
2727
pip install -r doc/requirements.txt
2828
```
2929

30-
Then we generate the doxygen technical documentation xml files and use Sphinx to generate the html files with the full documentation:
30+
Then we generate the Doxygen technical documentation XML files and use Sphinx to generate the HTML files with the full documentation:
3131

3232
```
3333
doxygen doc/Doxyfile
3434
sphinx-build doc doc/build
3535
```
3636

37-
And we can view the generated documentation by opening `doc/build/index.md` in a browser.
37+
And we can view the generated documentation by opening `doc/build/index.html` in a browser.

doc/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
project = 'CorticalSim3D'
1010
copyright = '2017-%Y'
11-
author = 'Eva Deinum, Bandan Chakrabortty, Simon Tindemans, Jaro Camphuijsen, Alex Hadjiivanov'
11+
author = 'Eva Deinum, Bandan Chakrabortty, Simon Tindemans, Jaro Camphuijsen, Alexander Hadjiivanov'
1212
release = ''
1313

1414
# -- General configuration ---------------------------------------------------

doc/introduction.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Introduction
22
Plant morphogenesis is strongly dependent on the directional growth and the subsequent oriented division of individual cells.
3-
It has been shown that the plant cortical microtubule array plays a key role in controlling both these processes.
3+
It has been shown that the plant cortical microtubule array plays a key role in controlling both of these processes.
44
This ordered structure emerges as the collective result of stochastic interactions between large numbers of dynamic microtubules.
5-
To elucidate this complex self-organization process a number of analytical and computational approaches to study the dynamics of cortical microtubules have been proposed.
6-
To date, however, these models have been restricted to two dimensional planes or geometrically simple surfaces in three dimensions, which strongly limits their applicability as plant cells display a wide variety of shapes.
5+
A number of analytical and computational approaches to studying the dynamics of cortical microtubules have been proposed in order to elucidate this complex self-organization process.
6+
To date, however, these models have been restricted to two-dimensional planes or geometrically simple surfaces in three dimensions, which strongly limits their applicability as plant cells display a wide variety of shapes.
77
This limitation is even more acute, as both local as well as global geometrical features of cells are expected to influence the overall organization of the array.
8-
CorticalSim3D is a framework for efficiently simulating microtubule dynamics on triangulated approximations of arbitrary three dimensional surfaces.
8+
CorticalSim3D is a framework for efficiently simulating microtubule dynamics on triangulated approximations of arbitrary three-dimensional surfaces.
99
This allows the study of microtubule array organization on realistic cell surfaces obtained by segmentation of microscopic images.
1010

1111

0 commit comments

Comments
 (0)