JSdocs on Query parameter is incorrect
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 75/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- typescript
- Domain
- documentation
Research direction
Start by locating the TypeScript Query interface containing the numerator and denominator JSDoc shown in the issue. Verify the metric equation's numerator and denominator meanings, update the two descriptions to match them, and confirm the generated documentation reflects the corrected semantics.
Written by the indexing model from the issue text.
Description
export interface Query {
/**
* A Datadog metric query for total (valid) events.
*
* @schema Query#Numerator
*/
readonly numerator?: string;
/**
* A Datadog metric query for good events.
*
* @schema Query#Denominator
*/
readonly denominator?: string;
}
Here in the docs, it tells us the numerator represents the total events (including good events), and the denominator represents the good events.
However, in the equation, the numerator is the top number, and the denominator is the bottom number in the fraction. In this case, the total events are always greater than the good events; as a result, the result of the equation is always greater than 1, which is incorrect.
Proposed fix
export interface Query {
/**
* A Datadog metric query for good events.
*
* @schema Query#Numerator
*/
readonly numerator?: string;
/**
* A Datadog metric query for total (valid) events.
*
* @schema Query#Denominator
*/
readonly denominator?: string;
}
- Dominant language
- TypeScript
- Stars
- 66
- Forks
- 5
- Avg merge
- 7d 43m
- Merged PRs (30d)
- 1
Contributor guide
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 cdklabs/cdk-cloudformation
-
Difficulty 3/5 1-2 days Newbie friendliness 50/100
cdklabs/cdk-cloudformation#778 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
cdklabs/cdk-cloudformation#709 · 1 comment ·
All issues in cdklabs/cdk-cloudformation
Similar issues
-
calcite-components needs triage refactor
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Esri/calcite-design-system#15203 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 91/100
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
Difficulty 1/5 Under an hour Newbie friendliness 95/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Automattic/studio#4908 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100