Add doctest to `update_recipe_file.py` in `configure_standardise`
- Dominant language
- Python
- Stars
- 5
- Forks
- 3
- Avg merge
- 5d 6h
- Merged PRs (30d)
- 8
Description
Given the below information is already contained within the docstring for `update_recipe` in `update_recipe_file.py` add a doctest.
```python
"""
Recipe file/datasets section snippet (human written YAML)::
datasets:
- {dataset: , project: , exp: ,
ensemble: , grid: , start_year: ,
end_year: }
- {dataset: , project: , exp: ,
ensemble: , grid: , start_year: ,
end_year: }
Updated recipe file/datasets section snippet (machine written YAML)::
datasets:
- {dataset: , end_year: , ensemble: ,
end_year: , exp: , grid: , project: ,
start_year: }
- {activity: , dataset: , end_year: ,
ensemble: , exp: , grid: , project: ,
start_year: }
"""
```
Contributor guide
Research direction
Open update_recipe_file.py and read the update_recipe docstring, including the existing recipe YAML examples. Add a doctest that exercises the documented update behavior, then run the doctest for this file and confirm it passes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, testing-qa
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100