Skip to content

Commit 24bda33

Browse files
committed
README
1 parent ed99c62 commit 24bda33

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@ You can modify the list of AD types in `main.jl`.
1414

1515
You can modify the list of models by:
1616

17-
1. Adding a new call to `@include_model {category_heading} {model_name}` in `main.jl`.
18-
**Both `category_heading` and `model_name` should be strings.**
17+
1. **Adding a new call to `@include_model {category_heading} {model_name}` in `main.jl`.**
18+
Both `category_heading` and `model_name` should be strings.
1919

2020
`category_heading` is used to determine which table the model appears under on the website.
2121
This should be self-explanatory if you look at the [current website](https://turinglang.org/ADTests).
2222

23-
2. Adding a new file, `models/{model_name}.jl`.
23+
2. **Adding a new file, `models/{model_name}.jl`.**
2424

2525
The basic structure of this file should look like this, where `model_name` is replaced accordingly:
2626

@@ -45,7 +45,7 @@ You can modify the list of models by:
4545
model = model_name(data, ...)
4646
```
4747

48-
**(1) Model name**
48+
**(1) Description**
4949

5050
Ideally, `model_name` would be self-explanatory, i.e. it would serve to illustrate exactly one feature and the name would indicate this.
5151
However, if necessary, you can add further explanatory comments inside the model definition file.

0 commit comments

Comments
 (0)