Skip to content

Commit e869589

Browse files
committed
Remove remaining TODOs from the documentation
1 parent 3d2a8e0 commit e869589

4 files changed

Lines changed: 2 additions & 14 deletions

File tree

docs/src/developers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,4 +122,4 @@ Not all combinations of weather data structure/weather dataset size/status sizes
122122

123123
They were briefly mentioned earlier in the page, but the test banks to increase the number of combinations tested for in terms of weather data, modellists/mappings and tracked outputs, could definitely be improved upon.
124124

125-
TODO extra section on memory allocations, type stability etc.
125+
Some additional work and tests regarding tracking memory allocations, type stability etc. would also be worth implementing/documenting.

docs/src/prerequisites/julia_basics.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,4 @@ Also of importance:
5252

5353
Many of these are also briefly presented in [this Julia Data Science](https://juliadatascience.io/julia_basics) guide, which also happens to focus on the DataFrames.jl package.
5454

55-
Understanding more about methods, parametric types and the typing system is usually worthwhile, when working with Julia packages.
56-
57-
TODO point to Rémi's videos ? Other videos ?
58-
TODO extra concepts useful for developers ?
59-
55+
Understanding more about methods, parametric types and the typing system is usually worthwhile, when working with Julia packages.

docs/src/troubleshooting_and_testing/implicit_contracts.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,12 +64,6 @@ This rule avoids potential ambiguity which could then cause both problems in ter
6464

6565
A workaround for some of the situations where this occurs is described here : [Having a variable simultaneously as input and output of a model](@ref)
6666

67-
## TODO Organs missing in the MTG but declared in the mapping ?
68-
69-
## Status template intialisation order TODO
70-
71-
## TODO simulation order, node order, etc.
72-
7367
## Simulation order instability when adding models
7468

7569
An important aspect to bear in mind is that PlantSimEngine automatically determines an order in which models are run from the dependency graph it generates by coupling models together.

docs/src/troubleshooting_and_testing/tips_and_workarounds.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,8 +107,6 @@ out_pseudo_multiscale_successful = run!(mtg, mapping_pseudo_multiscale_adjusted,
107107

108108
This feature is likely to break in simulations that make use of planned future features (such as mixing models with different timesteps), without guarantee of a fix on a short notice. Again, bear in mind it is mostly a convenient shortcut for prototyping, when doing multi-scale simulations.
109109

110-
TODO workaround status initialisation bug ?
111-
112110
## Cyclic dependencies in single-scale simulations
113111

114112
Cyclic dependencies can happen in single-scale simulations, but the PreviousTimestep feature currently isn't available. Hard dependencies are one way to deal with them, creating a multi-scale simulation with a single effective scale is also an option.

0 commit comments

Comments
 (0)