CABLE-LSM / benchcab

Tool for evaluation of CABLE land surface model
https://benchcab.readthedocs.io/en/latest/
Apache License 2.0
2 stars 4 forks source link

Update outdated configuration options in documentation #290

Closed SeanBryan51 closed 6 months ago

SeanBryan51 commented 6 months ago

Fixes #269

codecov[bot] commented 6 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 69.97%. Comparing base (59910ed) to head (bb0ab3d). Report is 6 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #290 +/- ## ========================================== - Coverage 72.81% 69.97% -2.84% ========================================== Files 18 18 Lines 982 986 +4 ========================================== - Hits 715 690 -25 - Misses 267 296 +29 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

SeanBryan51 commented 6 months ago

Preview link for documentation: https://benchcab--290.org.readthedocs.build/en/290/

ccarouge commented 6 months ago

I've just seen this. While you are at it, would you mind correcting the last line in the repo description:

### [repo](#repo)

Contains settings to specify the CABLE branch to test against. 

This key is _required_. The `repo` key must specify either the [`svn`](#+repo.svn) key or the [`git`](#+repo.git) key.

With:

This key is _required_. The `repo` key must specify the [`svn`](#+repo.svn), the [`git`](#+repo.git) or the [`local`](#+repo.local) key.