[Docs Update] 'coverage.range' documentation is contradictory
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 65/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Domain
- documentation
Research direction
Compare the coverage.range descriptions on the Codecov YAML reference and coverage configuration pages linked in the issue, starting with the stated defaults and range syntax. Update the contradictory documentation so both pages agree, then check both links and the surrounding explanation for consistent wording.
Written by the indexing model from the issue text.
Description
Description
These descriptions of the codecov.yml parameter 'coverage.range' are inconsistent.
Page(s)
https://docs.codecov.com/docs/codecovyml-reference#coverage
coverage.range
The value range where you want the value to be greenType: start...end
Default: 70..100
More Info: https://docs.codecov.io/docs/coverage-configuration#section-range
https://docs.codecov.com/docs/coverage-configuration#section-range
Default is described here as range: 60..80.
This value is used to customize the visible color range in Codecov. The first number represents the cutover from red to yellow, and the second represents the cutover from yellow to green. You can change the range of colors by adjusting this configuration.
Current State
[] Broken Link
[x] Unclear Language
[] Inconsistent Formatting
[] Missing Information
[] Missing Updates for New Features
[] Deprecated Features
Additional Information
- Dominant language
- No language data
- Stars
- 52
- Forks
- 26
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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.
More from codecov/feedback
-
Bug ReportOpen
Difficulty 5/5 Over a week Newbie friendliness 10/100
-
Difficulty 4/5 3-5 days Newbie friendliness 42/100
-
Difficulty 5/5 Over a week Newbie friendliness 30/100
-
Docs
Difficulty 5/5 Over a week Newbie friendliness 10/100
-
Docs
Difficulty 2/5 1-3 hours Newbie friendliness 20/100
All issues in codecov/feedback
Similar issues
-
Security SecurityBundle
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
symfony/symfony-docs#23173 ·
Maintainers usually reply within 3 days
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
containers/bubblewrap#813 · 1 reaction ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
szTheory/exifcleaner#383 ·
Maintainers usually reply within 1 day
-
[docs-scanner] Container proxy table misleadingly presents nested properties as separate parametersOpen
Difficulty 1/5 Under an hour Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
documentation good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 72/100