MetOffice / MetOffice/CMEW

Improve the error message when a `SITE` is not specified

Open
#217 0 comments 0 reactions 0 assignees View on GitHub
documentation enhancement good first issue
Dominant language
Python
Stars
5
Forks
3
Avg merge
5d 6h
Merged PRs (30d)
8

Description

Following on from #210, the error message return when running `cylc vip` is:

```
% cylc vip
$ cylc validate CMEW
Jinja2Error: Jinja2 Assertion Error: SITE must be set to something other than an empty string
File CMEW/flow.cylc
#!jinja2
# flow.cylc
{{ assert(SITE != "", "SITE must be set to something other than an empty string") }} <-- Exception
```

Improve this message by adding something about the fact that the `SITE` can be set by using `-O `.

Contributor guide

Open the contributing guide

Research direction

Start by searching the workflow's flow.cylc file for the assertion containing “SITE must be set to something other than an empty string,” then inspect how cylc vip reports that error. Update the message to mention setting SITE with -O , and run cylc vip without a SITE to verify the guidance appears.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Bug
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.