Improve description of run_bounds in mip_convert documentation
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8
- Forks
- 7
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 23
Description
Migrated Jira Issue CDDSO-91
Jira creation date 22/04/2022 13:49
-------
In the documentation at [https://code.metoffice.gov.uk/doc/cdds/mip_convert/user_guide.html?highlight=run_bounds|https://code.metoffice.gov.uk/doc/cdds/mip_convert/user_guide.html?highlight=run_bounds] there isn't any information about whether the start and end values in run_bounds are inclusive or not (the start bound isn't (i.e. it's ``start_bound >`` rather than ``start_bound >=`` )). It would be useful for users if this information could be included.
-------
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the linked mip_convert user guide and locate the run_bounds documentation. Check the documented start and end bound behavior against the issue description, then update the explanation so users can tell whether each value is inclusive; verify the rendered documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100