Improve readability of config.yaml documentation #140

ccarouge · 2023-09-15T10:27:03Z

This is a sub-issue of #135 that aims to improve the documentation. It is here so different points can be done separately.

Documentation of nested config options in config.yaml is hard to read. We could take inspiration from here, i.e. show the full nested yaml option.

- remove admonition box, now redundant - list experiments in table - changed "required option" to "required key" for consitency with "optional key"

#140 - Alternate config_options style

ccarouge mentioned this issue Sep 14, 2023

Polish documentation #135

Open

3 tasks

ccarouge added a commit that referenced this issue Sep 15, 2023

#140 - Finish first reformatting

390db68

ccarouge added a commit that referenced this issue Sep 15, 2023

#140 - remove a level of heading and reorganise options

6688edf

ccarouge added a commit that referenced this issue Sep 22, 2023

#140- response to review

efc9b36

- remove admonition box, now redundant - list experiments in table - changed "required option" to "required key" for consitency with "optional key"

ccarouge added a commit that referenced this issue Sep 26, 2023

Merge pull request #137 from CABLE-LSM/135-polish-documentation

162f554

#140 - Alternate config_options style

ccarouge closed this as completed Oct 4, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve readability of config.yaml documentation #140

Improve readability of config.yaml documentation #140

ccarouge commented Sep 15, 2023 •

edited

Loading

Improve readability of config.yaml documentation #140

Improve readability of config.yaml documentation #140

Comments

ccarouge commented Sep 15, 2023 • edited Loading

ccarouge commented Sep 15, 2023 •

edited

Loading