|
21 | 21 | "\n", |
22 | 22 | "- Module structure\n", |
23 | 23 | "\n", |
24 | | - "- Low-level modules, such as `core` and `image`.\n", |
| 24 | + "- Low-level modules, in particular `core`.\n", |
25 | 25 | "\n", |
26 | 26 | "- The `features` module.\n", |
27 | 27 | "\n", |
28 | | - "- The `image` module.\n", |
29 | | - "\n", |
30 | 28 | "- High-level modules, such as `holography` and `optics`.\n", |
31 | 29 | "\n", |
32 | 30 | "- Utility and handle modules." |
|
48 | 46 | "source": [ |
49 | 47 | "## 2. Module Structure\n", |
50 | 48 | "\n", |
51 | | - "Each module should be clearly documented in the beginning.\n", |
| 49 | + "Each module is extensively documented.\n", |
52 | 50 | "\n", |
53 | | - "Often modules contain some **abstract classes** to provide a standardized implementation of core functionalities (for example, image transformation) to ensure consistent output formatting across all derived classes in the module (for example, to ensure that the format of the output image is the same)." |
| 51 | + "Often modules contain some **abstract classes** to provide a standardized implementation of core functionalities (for example, image transformation) to ensure consistent output formatting across all derived classes in the module." |
54 | 52 | ] |
55 | 53 | }, |
56 | 54 | { |
|
103 | 101 | "source": [ |
104 | 102 | "## 3. Type Hints for Code Readability\n", |
105 | 103 | "\n", |
106 | | - "As type hints are used extensively to improve code readability in accordance with the [style guide](https://github.com/DeepTrackAI/DeepTrack2/blob/develop/tutorials/4-developers/DTDV411_style.ipynb), DeepTrack2 introduces a few custom type hints for internal use, which are declared in the [types.py](https://github.com/DeepTrackAI/DeepTrack2/blob/develop/deeptrack/types.py) module." |
| 104 | + "Since type hints are used extensively to improve code readability in accordance with [DTDT411. Style Guide](https://github.com/DeepTrackAI/DeepTrack2/blob/develop/tutorials/4-developers/DTDV411_style.ipynb), DeepTrack2 introduces a few custom type hints for internal use, which are declared in the [types.py](https://github.com/DeepTrackAI/DeepTrack2/blob/develop/deeptrack/types.py) module." |
107 | 105 | ] |
108 | 106 | }, |
109 | 107 | { |
|
124 | 122 | "```python\n", |
125 | 123 | "from __future__ import annotations\n", |
126 | 124 | "\n", |
127 | | - "from .types import ArrayLike, PropertyLike\n", |
| 125 | + "from deeptrack.backend.types import ArrayLike, PropertyLike\n", |
128 | 126 | "\n", |
129 | 127 | "def ClassName():\n", |
130 | 128 | "\n", |
|
0 commit comments