Skip to content

[Documentation] Document Limit Evaluators#8336

Open
DakshUbhadia wants to merge 1 commit into
nasa:masterfrom
DakshUbhadia:mct8165
Open

[Documentation] Document Limit Evaluators#8336
DakshUbhadia wants to merge 1 commit into
nasa:masterfrom
DakshUbhadia:mct8165

Conversation

@DakshUbhadia

Copy link
Copy Markdown

Closes #8165

Describe your changes:

Expands Limit Evaluator documentation in API.md and adds TSDoc for the LimitViolation object in telemetryAPI.js. This ensures consistency between the API documentation and source code.

Testing Instructions:

  1. Code Affected: API.md and telemetryAPI.js.
  2. Verify markdown renders correctly in API.md.
  3. Verify TSDoc syntax is valid in telemetryAPI.js.
  4. Run npm run lint and npm test to ensure no build regressions (verified locally).

(Note to reviewers: I have just emailed my signed Individual CLA as this is my first contribution).

All Submissions:

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  • Is this a notable change that will require a special callout in the release notes? For example, will this break compatibility with existing APIs or projects that consume these plugins?

Author Checklist

  • Changes address original issue?
  • Tests included and/or updated with changes?
  • Has this been smoke tested?
  • Have you associated this PR with a type: label? Note: this is not necessarily the same as the original issue.
  • Have you associated a milestone with this PR? Note: leave blank if unsure.
  • Testing instructions included in associated issue OR is this a dependency/testcase change?

Reviewer Checklist

  • Changes appear to address issue?
  • Reviewer has tested changes by following the provided instructions?
  • Changes appear not to be breaking changes?
  • Appropriate automated tests included?
  • Code style and in-line documentation are appropriate?

Expands Limit Evaluator documentation in API.md and adds TSDoc
for the LimitViolation object in telemetryAPI.js. This ensures
consistency between the API documentation and source code.

Addresses nasa#8165
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document limit evaluation object

1 participant